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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiIwYXhTMXp5d2d2ZTdIY3dlWHJxdUdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY3NThmMTI4LTQ3NGEtNDFlMy1iNTgwLTBlYTFmMzMzNzk5YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NCwiZXhwIjoxNzQ5NTcxNjg0LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjdlOWFlZmI4LWZjZmUtNDc1Mi1iNDk3LTJmNjA4ODUyMTAyOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4NH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNjIxOWNmNjAtMGNmMC00YmQ5LWIxMWItYjVmOGYxMTY0ZDZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiYjQ4MGU0NTEtNGRhMS00YWE2LTgxZjctZDgyN2I1ZTg4ODE3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiYjk0YTFiMTMtYzljOS00ZmY1LTg5OWEtNjdmYWVjMjE5NWFkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDcyfSx7XCJpZFwiOlwiZGIwZTRlZDMtMzU0ZC00YjdkLTlhOGUtMzAwYWZhYzc1NjMwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiNzc2NDg4ZmItYmZiZi00NjExLWFjNjMtNDMwOGExNzFlMDViXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU3fSx7XCJpZFwiOlwiNWE4OTc2ZWItYjExNi00ZDZmLWE4MWYtOTA1Mjg5OGU4Y2M4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiOGEzMTRjNjEtMjJmNS00YTA1LWI5NGQtNzkwNzQyNTU5MDRhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU1fSx7XCJpZFwiOlwiZThlYTMyOGEtMGVkMS00MWI2LTg5MDQtNmY1YzVmMDkwYzg2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU3fSx7XCJpZFwiOlwiMmExZDY4Y2EtNDJlMC00MGUxLTk4OTQtMzRmOTYwMmY1ZTVlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU1fSx7XCJpZFwiOlwiYTI1ZGY0ZjAtNTBkZi00MmJiLTlmMjUtODkyNjYzYjQzMDA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU4fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fot2dsih7yw4SWauS8ktekQRGnD5HIu-kWyPJ4BBSr4KoBqSes0noAYtPy3AGxt_liERRyEp_pWXWwgo7qNMHVTIFL6gu4sRhn5FoFaq_D4Uj4LCGNUB_lpEG3tzRe4zx0vBBVieBO8xCcjKr412bAfAtxIdk4Rkf8uMUBsoQ0bYvBi3jZ88UC_g0dr2fOZYA6xKR8kuaf8JNDHM5_Uwqt3znnjawOpPL3Bn1m92dE52uvYt8K1gia54ZNeAbRpJ1Deyh0eMVT4h2RXrknNM-QTW1mfEYwAZr6vbS0kNtRXa5MByt69RGNPnbbpKNUuYg47Yx6Qpqs4crr1YxfBDWA' \
-d '{"identityId":"896dc3c5-96a5-4919-b892-592394524049","audience":"io.netfoundry.test","claims":{}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1950
{
"token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJRdzVQOTMwMzl0QXhTbmhKMUg5RjdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg5NmRjM2M1LTk2YTUtNDkxOS1iODkyLTU5MjM5NDUyNDA0OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTc0OTU2ODA4NCwiZXhwIjoxNzQ5NTY4Mzg0LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImJiZWJmYzQwLWJhNGUtNGI3MC1iYzQyLWFjMjg2M2UzOTU2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNjIxOWNmNjAtMGNmMC00YmQ5LWIxMWItYjVmOGYxMTY0ZDZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiYjQ4MGU0NTEtNGRhMS00YWE2LTgxZjctZDgyN2I1ZTg4ODE3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiYjk0YTFiMTMtYzljOS00ZmY1LTg5OWEtNjdmYWVjMjE5NWFkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDcyfSx7XCJpZFwiOlwiZGIwZTRlZDMtMzU0ZC00YjdkLTlhOGUtMzAwYWZhYzc1NjMwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiNzc2NDg4ZmItYmZiZi00NjExLWFjNjMtNDMwOGExNzFlMDViXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU3fSx7XCJpZFwiOlwiNWE4OTc2ZWItYjExNi00ZDZmLWE4MWYtOTA1Mjg5OGU4Y2M4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiOGEzMTRjNjEtMjJmNS00YTA1LWI5NGQtNzkwNzQyNTU5MDRhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU1fSx7XCJpZFwiOlwiZThlYTMyOGEtMGVkMS00MWI2LTg5MDQtNmY1YzVmMDkwYzg2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU3fSx7XCJpZFwiOlwiMmExZDY4Y2EtNDJlMC00MGUxLTk4OTQtMzRmOTYwMmY1ZTVlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU1fSx7XCJpZFwiOlwiYTI1ZGY0ZjAtNTBkZi00MmJiLTlmMjUtODkyNjYzYjQzMDA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU4fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f2gn2vL65mHLWEMx81qqXsM8ZdXF0HzHkQderVaiqFg6uvExmVy8cSTEgeXvs5ArvzJEa_B9Kfmzm5ODvD-uz50_wxGxzapuEwIvQ6XEauInbGkSecm84MOrVNHRfdp-1uHA_bcMDVrVUJ0yBWkQRW_YeC8JdE3cZomx2Fs6S2k8BrAoL76lmzcqE9DtweauZgG8Tas7JyasmZzkl7dQuOFCTEErtnKEkviWsopINjAl4bBxa7FVSHVDrl-ijt9wq4wMQAWO_HmrsB1Ucm1wzI1kLsAmmlugZY-V1UZcZJV5Ek-BfbyOGrVSiEGdVqf3zgK7Wu8PonH2RLCLCvxRuw"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJXcjZyYTJsVU1wcEZFLW1zR2M1aktRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJjZGRmNWJlLWQ1YWYtNDE4ZS1iODdiLTBjZTNlY2RiY2VlMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NiwiZXhwIjoxNzQ5NTcxNjg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzc4ZTY3MzctZWI0Ni00Y2UzLWI4ZjEtNzdiOGY5OGY0OTZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.M5IEgLvssS7tLPFjCxmgxxO74yY10SIo3fXZ-qv7KQ4lE_J2EgftDmzoghOeocRtRye0HQYfPNj-Vg189SiIQnoDOE2soHlpO0mwi6fRVMGcb_dEUbAra_Le1iOZa1AxcM-le53yrr0NP8mc178FAC2sogla8zah9fehEJ-7ymOUhfd1L6dWgo_4IbsrRFs9QkqoOy8SqGxFlvBgjqa9Epvu7__lcLl9mYuLCziE1Ergg-Tksq2hk4xyrCyOSGMXjN7BiIoCPy4cBqb3mpxL6IbL0JuJQ_T1e9v8ItOgoA_47a0LA9xOE8Ds-ZRMub1MfrpMNUOZ3oIIJzgmJwbrAw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 872
[ {
"id" : "1c58457c-fd8e-439d-84ce-7275eb63cbab",
"name" : "Applications",
"code" : "io.netfoundry.app",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:40.152570Z",
"updatedAt" : "2025-06-10T15:07:40.152570Z",
"_title" : "Applications"
}, {
"id" : "2822ac51-5a51-4289-ae36-6fc1c50a9e7b",
"name" : "Networks",
"code" : "io.netfoundry.network",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:35.508704Z",
"updatedAt" : "2025-06-10T15:07:35.508704Z",
"_title" : "Networks"
}, {
"id" : "3a1207c9-f653-40be-b53f-c1c920b6db97",
"name" : "Test Domain 24",
"code" : "test.domain.24",
"createdBy" : "7b63362c-0933-4481-ae5a-4ad4bb8bc0b0",
"createdAt" : "2025-06-10T15:08:04.792779Z",
"updatedAt" : "2025-06-10T15:08:04.792779Z",
"_title" : "Test Domain 24"
} ]
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/37a4e884-0dcd-4d9c-96a4-988576b184b5' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJlckZKTjBEUjFNMVdHVlB5MVI0RFJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFmY2ZlYzliLTBkMTgtNDAzMC1iZGI0LTE0MzM3OTExNzk0OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NiwiZXhwIjoxNzQ5NTcxNjg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTUwNzczYTMtYWM0NC00MzgyLThlZjUtNjI1MjI0ZGVmYWJjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.igUaDFYBmGaWSt-Us0W_b8Hc2h4r1p4WYJ1k54i3KhLdSkZXCSJIyHC_d8CliradUcE1jY5tmMSeiQhE5cgLf5oX1mCils6kCCBN0q4a29JlfY1ibKx50J-v3Y7JXYpuvSjGPThbtGnEI1x4TdreQgLxhNS5hKhBqsrEYaVgm7gP0hPJwXhXsMefnjvW6kmXNbpcxXSQrum01P0XGY8LbN62ydCWrkUeCSUDluhbrGb55LoPiehL99T0rLtCE7L4tMXkKTBLvNZOwNcLgZgX8CqXu3eshvLf_Kc_LP1z0LbENxk-sseIdkraM1xFfmWrZm49LCxHeyWkzB2HWiGuFg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 288
{
"id" : "37a4e884-0dcd-4d9c-96a4-988576b184b5",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "2fe669fc-097d-4416-a46d-d10df90e031f",
"createdAt" : "2025-06-10T15:07:52.627632Z",
"updatedAt" : "2025-06-10T15:07:52.627632Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJrRGFzZEtyNlZXNXRpOHlkTm43a1NBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBiZmZhNDk1LWZkOWItNGYwMy1hY2FlLTFmYjIwMjk3ODUwMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NywiZXhwIjoxNzQ5NTcxNjg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzFjMDUzZTUtMjRjMC00ZjE1LTg0NWEtNjRhMTRmMzA5NTg3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.vCYBXDjIkGBHsUfIDT5lR41VhcYkgJ9XYMKs6DvOb2H-o9yNde7DlAMyjiI5Mc68XiPpA0SXg4PKQBDDiIxkImD5LfByIKjA4bzmfv6bY-j6qsUhqWP3LWFAUFj9mE8efSxksFjJVa-72aBIRPz_IOpC3gKTcAVerE6EgJAQnZuZ5gxOfU9zpWJSDUN8rA0u7pTejvaNKL1lOOjqyJ4V4LQepjHNYpLyYYwYnJmxztSDEtvXP5HgjnqxSZvhIpPDHH-a4Q6RpsbPZpWJfmPWW3AKNZw2UkTwcQB2VXVoCtt8xPSaV5NDBKhGS6qOF-Z8KJ0JD2JCVPOYOf6LOa0Afw'
Example response
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 288
{
"id" : "37a4e884-0dcd-4d9c-96a4-988576b184b5",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "2fe669fc-097d-4416-a46d-d10df90e031f",
"createdAt" : "2025-06-10T15:07:52.627632Z",
"updatedAt" : "2025-06-10T15:07:52.627632Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJBLXlQVnppM1E0QnZVRHlCS0pjOEx3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQwOGY5MWRiLTJhMTUtNDMzMS05Mzc3LTE4NTgzMDdhYjQ3NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NywiZXhwIjoxNzQ5NTcxNjg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmRlNWY1MzAtNGNmYS00MmE3LTk1M2YtMTJjNDM0MzI4YzUyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.RxayR39K2RCt1dGw4xixdX7BwmuaTSvL8ljbXGE6Uh9U87dyC2EZbmAvShf5nRTolzaaRAySf2SvDNSBEhAUS3WJV3nCDwP5Te6WM88NMfGz5GiM3w1Lch1Jnpr1VE9h-7ek0P35JM4raM_Bw4FuYkYFaYceG80V50WcjxA9HGQ7QV8gjqILAWNYbG6Du4HT4PkUeuqAVVA29Z__VA8SS8Mz2NRVnwgG1-ISgXib8r4SZRcz5-ISyBrqJNzZYlrqNVaz6q7-0VBrViJfnrcObx1hU88CNczjq8nKMZqoXf_s6XlBInNWKkuhScn4_B1H9NlR37buSknDDMm405mdZw' \
-d '{"name":"Other Test Domain","code":"other.test.domain"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 299
{
"id" : "87f65410-2549-495f-ba57-16979b6e7324",
"name" : "Other Test Domain",
"code" : "other.test.domain",
"createdBy" : "408f91db-2a15-4331-9377-1858307ab474",
"createdAt" : "2025-06-10T15:08:07.328817Z",
"updatedAt" : "2025-06-10T15:08:07.328817Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJ2NDI5MmJwTldNUFh2SGpZTFJCeDRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUxNWYwMGMwLTI2NDctNDZkYy05ZmE3LTQ5OGEyOWRjZjIwZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OSwiZXhwIjoxNzQ5NTcxNjg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDM0MjQzNDQtMDIxYi00NzUwLWFiYzctZjU5YzU4YzRlMTcwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f9d9Mc7rSlM2dkUeqXPNN-oMvwogDVgKLODhrYy5PvxlIrnd-_IeVfCh3p0JjZhcjkikIzaDf0iQnp7FXUinv1UsqI1QBZnVuMjieERTC1KWuy53Ahnpp8QscLOclZP4quyE6V3BJthJm57eCmynqVBerIH9HcdWE5grnuwE7dq_WX6SV9nA9m8ULh2VWXS-i4mooRXNfH7v23fFh3vfv0Bl0JdSegl_y0v3wQv5bzAox5ZY-Q7s41eZlFwFCTlUXK42vlBCyi06I4aFvyVj1jqh8iKodIeGkpo5FUDqkyVDemweA_oMkSgUhqhK3PZYvpc7aKecDPNxvaajzQZOFg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1323
[ {
"id" : "89e9a762-c24d-45c1-a118-4e2910dde5f6",
"domainId" : "2822ac51-5a51-4289-ae36-6fc1c50a9e7b",
"name" : "Geo Region",
"code" : "geo-region",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:35.510263Z",
"updatedAt" : "2025-06-10T15:07:35.510263Z",
"parentId" : null,
"root" : true,
"depth" : 0,
"childrenIds" : [ ],
"_title" : "Geo Region"
}, {
"id" : "1308a8ca-12e0-4b77-95a6-7dbcf5c833b5",
"domainId" : "b7826ce7-5fe6-4108-8fe7-1969048bc9b2",
"name" : "OIDC Audience",
"code" : "oidc-audience",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.895112Z",
"updatedAt" : "2025-06-10T15:07:39.895112Z",
"parentId" : "599fc53c-7569-4934-a855-0f2847ec50c4",
"root" : false,
"depth" : 1,
"childrenIds" : [ ],
"_title" : "OIDC Audience"
}, {
"id" : "ec1ae9a7-3c77-4b7b-8db1-7cd610ec0360",
"domainId" : "2822ac51-5a51-4289-ae36-6fc1c50a9e7b",
"name" : "Stored Secret",
"code" : "stored-secret",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.818914Z",
"updatedAt" : "2025-06-10T15:07:39.818914Z",
"parentId" : "1524aa37-b61f-4408-9e2f-b624c3693c4c",
"root" : false,
"depth" : 1,
"childrenIds" : [ ],
"_title" : "Stored Secret"
} ]
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/a7b4bee0-5831-477b-b3e7-ea1f7f10f0da' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJKNWRRTmNSN0FuUzRqME4wV0RCZEhnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIzMTc0NDA0LWY5MjAtNDk1NC05NmFhLWU1ODAzNTU1Y2Q2OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OSwiZXhwIjoxNzQ5NTcxNjg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGYzYWFmNGEtMDM3Mi00YzdlLTg3OGYtYTI1OTQxMDVlMDFmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.M-_ypExgMRpSckshp0ar33nALIF-oJc6tuw77JhhOWXr2zyREdynmT90tPl8xe2CFhI7eCoCS1HqGeUFYtVMGrzmDpW7wyyUMGO3OlflqGYS3CBhzjVrNtP7YnrzcvAPKmFNYSZSe438bJfYRPpGW7KxwDQAsxXNA7R4m7lUMvfNzc9Q5W49gzcYUnSXgR6c1IX0cKTuCZB0mKJlpUmtdsoiS-GHBeFTs-7FBwdj68vknRgxVzli1g9PU4c5Qjy7h4YBkeSLhl7jxEiaDR_4GjQshDSNUHrHWB_J97XhUEEL_hAzFmvZ-34SMLrBsdRjs7jfWI-IBHlomdzYqzy4pg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 406
{
"id" : "a7b4bee0-5831-477b-b3e7-ea1f7f10f0da",
"domainId" : "37a4e884-0dcd-4d9c-96a4-988576b184b5",
"name" : "Test Type",
"code" : "test-type",
"createdBy" : "4fa5b2c9-42a0-441b-98d6-abfa541d9baf",
"createdAt" : "2025-06-10T15:07:52.728717Z",
"updatedAt" : "2025-06-10T15:07:52.728717Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJTcl9aU2laTUhQNlgyNFkyNTJSWnNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE3YmM4NGU5LTY2MTQtNDY3Yi1iOTEwLTYwZGIzMjg1N2NkOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OSwiZXhwIjoxNzQ5NTcxNjg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2ZhZjgyMGUtOTNjMy00ZDU5LTg3ZTItMjVmNmNjNjhjM2JlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fSx7XCJpZFwiOlwiNWZmZmM0NWUtNzY5ZC00M2MzLWJjMGYtMjJjOGNiY2YwYzhlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fSx7XCJpZFwiOlwiZGExMTkwNGQtY2UxNC00ZDJiLTliOGMtNjdiNDYwOTczNzdmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Y5WfbV5OKXhQ99yD1-q6bo-HCLhFHOy_jfgR__K_2Vdrci62wPRviLnaEtOClUdPvJYyNutSp9qTdzT-iYMeAJa3kDbonOI7Tm4O-IkXABVzZ1l2Ad5ikrkyKdbkvv0NusM0TiR7O6bubR_r16Y7BaFusGNFrc4WqjzIZyA5u42LxcRMgc-ZZLU628UJnrnWiEDK29RLpXgWCYnQ2RWz576bUzI2MmFOTamvVvpoWTavNbmhfaLAep7V8U_5wL0Per-CWu8pQaVfAHj5RJpkukImTgVAfnD8OZTQ0c4lQRNSQP_toNbL0uMOFS1LWIgAEu8k6M_MZTmafXWXGbEZ0g' \
-d '{"domainId":"37a4e884-0dcd-4d9c-96a4-988576b184b5","parentId":"a7b4bee0-5831-477b-b3e7-ea1f7f10f0da","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" : "ba1b19de-0034-4acf-8b2e-537e708646d3",
"domainId" : "37a4e884-0dcd-4d9c-96a4-988576b184b5",
"name" : "Another Test Type",
"code" : "anoter-test-type",
"createdBy" : "17bc84e9-6614-467b-b910-60db32857cd8",
"createdAt" : "2025-06-10T15:08:09.967480Z",
"updatedAt" : "2025-06-10T15:08:09.967480Z",
"parentId" : "a7b4bee0-5831-477b-b3e7-ea1f7f10f0da",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJRRzhrS2ZUdUItNGlBMy00NG9ENVpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNhY2M5NDk2LTg4OTYtNDJmOS1iYzc5LWY3ZjM0NjAwZDUyYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OSwiZXhwIjoxNzQ5NTcxNjg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzcxMDAzOTItYjA1Yy00N2Q5LWJhNjAtYWJiZDc5NmI5ZDk0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ysoHoaa12_yCnb_VMsIeOV8C9y-cJ8Ruv7veMuvwmkbNR85ssyjz5B-odM4FD8BaZ2gK1kmb5uEx-dXGAKJ7HTACWquF37BK5ZyXlfVKL59PVPbfdGkCYXMo9ahvS55sN5-evV_kE_p6-Lv8yWfEF9g_83hptPDgZC32W7-jsyZXnl2YtTx1ypF8tL834eTtaHcEmx7Z2oGg-Ek00Yz4bB98TIdJrS75wd4jjntaye0hY52fdT5eUHFutj3XdWAcaro0Io8UmPoK48mbeoJj4CNkRBUfO1XLgh9IdqT0AlBucYb21ZnoHmEGvD0csV9G1vbRptIDAfZXXrVacWyxGw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1124
[ {
"id" : "204f2e06-cde4-4407-a1e4-faed4b79665f",
"resourceTypeId" : "fca69ac5-0600-4f74-96f0-d09e7c2f01d5",
"name" : "Delete",
"code" : "delete",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:37.699108Z",
"updatedAt" : "2025-06-10T15:07:37.699108Z",
"standardAction" : true,
"_title" : "Delete Network Version"
}, {
"id" : "4a0fa76c-2681-4537-baf2-a9236eea4dc1",
"resourceTypeId" : "e20f526a-8878-4c59-8ae6-6919b98eef35",
"name" : "Update",
"code" : "update",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.100046Z",
"updatedAt" : "2025-06-10T15:07:39.100046Z",
"standardAction" : true,
"_title" : "Update Http Agent"
}, {
"id" : "4e3fd471-0d95-47af-a484-ab5cc2a704dd",
"resourceTypeId" : "11a4d3ff-c63a-449e-b732-fe7d4baf626b",
"name" : "Create",
"code" : "create",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:37.578488Z",
"updatedAt" : "2025-06-10T15:07:37.578488Z",
"standardAction" : true,
"_title" : "Create Service Edge Router Policy"
} ]
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/80fc2188-f838-42b7-87c4-bdb003df9af2' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJ4b0M4THBxZ0xQZHFpRTkwdEdqZ0d3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNmOTRhOWI0LWRjZTQtNDYzNC1hMjk1LTRjYzU1NjkxYmZmZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OSwiZXhwIjoxNzQ5NTcxNjg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2Q1MTg4OGEtNGUxZi00NTJmLTkxMjMtNDRiMTRiMTNjMjA0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.wcLhpT6nUPRd_YRcs66KWl7M8QWFezXzxBO95j3Ls1necEbGj4tFxZT59TO3gBjbekPRGlDW6K_hc7RZ8eCS3uOdSQVb2ye98fLhdsW3X-Y6oWJaBWTxD40i3wTtE0sQWRqTwYjpq1c9YiuEVYO20pKqyyVbSBGFRtHGHmsHwuBkh2dSNF2OGPg0MAEKGvWv63B5qYRcgYnKYoEFlSR8LuuDnkXSh2JhGUG5fAeWayJYm_gOqx2ZgUIlnDnNdsz_J_Wv-W3LJJxxu9DWjtVqS0MYttfFRjN5NdpRyvBSFRGrLW0yiKAy2yxeOXGWktX3oeQkC63NWBPvcgU6uHM8fA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "80fc2188-f838-42b7-87c4-bdb003df9af2",
"resourceTypeId" : "a7b4bee0-5831-477b-b3e7-ea1f7f10f0da",
"name" : "Test Action",
"code" : "test-action",
"createdBy" : "9d0e5840-f414-4a2d-af92-076ffadb94ea",
"createdAt" : "2025-06-10T15:07:52.761722Z",
"updatedAt" : "2025-06-10T15:07:52.761722Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJyMmdESk9GMXRhSjdOUzhsWFZheXl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM1MGU2MTdmLTNhZWMtNDZjYS05NzdkLTA0YzcwZDE3Yjk2NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OSwiZXhwIjoxNzQ5NTcxNjg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGIxMTEwOWUtZTk5NC00ZmNmLTlkNWEtYzRhZTJhZGVkNmY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fSx7XCJpZFwiOlwiODQ1NGE1ZjQtYmUyNC00NzQ4LWE2ODItOGI2MDI2ZjY4OTBiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ml7-jlmEZuiJ8DH2gQV4QbjHWiYxxA4X3vPjUt6b398suim6RzMX2E9irYPok0S9PBik6c-YK9ylrfDG4QWLTV-qa0xPcLwRrJPYTvVjTatyQdsjU5FCN-Mr1Vt5SMDhYsWT0AR4-89lF-t2_s3Ps_myJKAYdzz0vZW4EC6ln9rmq7umriHGH0iUq3AhlVGDlX2YRZrTbBSLz_T_A5EtcrY2-vatwwZKiSTPMnEDgdKHclHbGq3dl0WxOPalqq769gFxBVkmsit4QQcXoD_iHfDnSQ0ewgkiEsWovGNwQ2SbD6sTC1S8ZRUFguNSYgtq6e6uL7Ov8GIPa4XB5yQs1A' \
-d '{"resourceTypeId":"a7b4bee0-5831-477b-b3e7-ea1f7f10f0da","actions":[{"name":"Update Custom","code":"update-custom"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390
[ {
"id" : "f517fcd0-c032-4946-8aac-31c10de9268b",
"resourceTypeId" : "a7b4bee0-5831-477b-b3e7-ea1f7f10f0da",
"name" : "Update Custom",
"code" : "update-custom",
"createdBy" : "c50e617f-3aec-46ca-977d-04c70d17b964",
"createdAt" : "2025-06-10T15:08:09.176905Z",
"updatedAt" : "2025-06-10T15:08:09.176905Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJzeHlubU5NTFNsSDNEWjMzVUs1X0tRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA0ZTI1MzI4LTUyZTAtNGQzYS1iODM0LWMwYzk0OGE0NDgzNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NywiZXhwIjoxNzQ5NTcxNjg3LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImU3MzVhN2E2LWJlOGEtNGRlMi1hZmQ5LWIyNGE0ZmJmMzg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4N31dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNjIxOWNmNjAtMGNmMC00YmQ5LWIxMWItYjVmOGYxMTY0ZDZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiYjQ4MGU0NTEtNGRhMS00YWE2LTgxZjctZDgyN2I1ZTg4ODE3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiYjk0YTFiMTMtYzljOS00ZmY1LTg5OWEtNjdmYWVjMjE5NWFkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDcyfSx7XCJpZFwiOlwiZGIwZTRlZDMtMzU0ZC00YjdkLTlhOGUtMzAwYWZhYzc1NjMwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiNzc2NDg4ZmItYmZiZi00NjExLWFjNjMtNDMwOGExNzFlMDViXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU3fSx7XCJpZFwiOlwiNWE4OTc2ZWItYjExNi00ZDZmLWE4MWYtOTA1Mjg5OGU4Y2M4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU2fSx7XCJpZFwiOlwiOGEzMTRjNjEtMjJmNS00YTA1LWI5NGQtNzkwNzQyNTU5MDRhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU1fSx7XCJpZFwiOlwiZThlYTMyOGEtMGVkMS00MWI2LTg5MDQtNmY1YzVmMDkwYzg2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU3fSx7XCJpZFwiOlwiMmExZDY4Y2EtNDJlMC00MGUxLTk4OTQtMzRmOTYwMmY1ZTVlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU1fSx7XCJpZFwiOlwiYTI1ZGY0ZjAtNTBkZi00MmJiLTlmMjUtODkyNjYzYjQzMDA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDU4fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.a5hG_IYYLi31SG2P2qpUABBqAUWITXEcJzsC2-bqQBlej6GbdZnK7mWMYsTyIYtJiP9X1JYJH_RMhlOpqaFuGRkkatBFBS0SizQvItKRFFDHI4wfoYF6NsZiCdnpEMTW4gACtabDaqlePScUAVqCNgu3SJOUhfPb_0NlZGlnklB_4Qp5o8z8i-R5eK-oToFG8jg1vou0qqWav50h8L3MH33egdbzxb1QUzap0bD3PG2mlVMP-yXo13WvK29wrgXPk4ymOSTRgw99MhE46tk1Bb5L9ueitWL1tTJZ09raw8phKC9Gcrp9mO4vHWH0K_jmf2CuyPGieWXt5azjvtmyLg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1801
[ {
"grantType" : "IdentityResourceAction",
"grantId" : "41486854-cbe6-4a96-af68-351c78895632",
"privilegeSourceId" : "41486854-cbe6-4a96-af68-351c78895632",
"identityId" : "16f645d6-e5ec-4d27-a542-64891f58b3a8",
"privileges" : {
"io.netfoundry.network" : {
"host" : {
"read-platform-protected" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:38.755436Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read Platform Protected Properties Host, All to identity 16f645d6-e5ec-4d27-a542-64891f58b3a8"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "01e77b5f-de75-470a-abef-644b48eb6ae3",
"privilegeSourceId" : "01e77b5f-de75-470a-abef-644b48eb6ae3",
"identityId" : "b60ce3a7-15ac-459d-b5b9-76797462c9ed",
"privileges" : {
"io.netfoundry.auth" : {
"custom-role" : {
"delete" : [ [ ] ]
}
}
},
"createdBy" : "c32bd567-d6bb-4815-b50d-41e9c4f77ef8",
"createdAt" : "2025-06-10T15:08:06.052284Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Delete Custom Role, All to identity b60ce3a7-15ac-459d-b5b9-76797462c9ed"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "4e07d1cb-9363-446c-a1e4-87c0dacbf07e",
"privilegeSourceId" : "4e07d1cb-9363-446c-a1e4-87c0dacbf07e",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"privileges" : {
"io.netfoundry.identity" : {
"api-account-identity" : {
"create" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:36.066324Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Create API Account Identity, 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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJoX3lCZ3F1TjE2MG51Q0djSE1wMmtBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI1NmFmNjRhLTZlZTUtNGIyYy1hOGRhLTFjYjIyOTk5NDQyMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MiwiZXhwIjoxNzQ5NTcxNjkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMmM3ZTFkOWYtMGY1NC00N2JhLTgzZTktM2JlNjE2NDMxNzViXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.HMF2RkK8Z1R1QUUGWf9VQyqHBg_tx8xpYGFlME_yCFK1ocApMfpNHXbcE0Dhj_Ogvn0vHcgEpfbUTIJ1tzy8rpMTOJcYgv3eiJ28bI-koWGVKHq6s9wWoCTdJKe3GTRJWUq_pPDOEyOlMJlF0wMs2C-8UX5rbQt5EF2QWZnpcxTVZKzbtC3yX1X1x6WIEyoBXZPjN9Pn53A0oGnnGVvwy0oGag3zZkN__JMxm-w4cWCfAsJXJJSTEu0jTVX-AdC1WAEJ-roYSbtqBkj2Gux5oV6U0OzoZu74-k2Wn0UMtT75uquf0OrdMZtPqptato8Kq_l3Dq6A_AUN2budTDH2Cw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1506
[ {
"id" : "e735a7a6-be8a-4de2-afd9-b24a4fbf386e",
"identityId" : "04e25328-52e0-4d3a-b834-c0c948a44836",
"domainId" : null,
"createdBy" : "8d6c3cf2-ad42-4dd7-aab0-ae2675b78b0a",
"createdAt" : "2025-06-10T15:08:07.412978Z",
"updatedAt" : "2025-06-10T15:08:07.412978Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 04e25328-52e0-4d3a-b834-c0c948a44836"
}, {
"id" : "bbebfc40-ba4e-4b70-bc42-ac2863e3956d",
"identityId" : "896dc3c5-96a5-4919-b892-592394524049",
"domainId" : "37a4e884-0dcd-4d9c-96a4-988576b184b5",
"createdBy" : "db24ce6a-2ba5-4e2e-906c-4ae2067e7de3",
"createdAt" : "2025-06-10T15:07:52.771922Z",
"updatedAt" : "2025-06-10T15:07:52.771922Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity 896dc3c5-96a5-4919-b892-592394524049"
}, {
"id" : "7e9aefb8-fcfe-4752-b497-2f6088521028",
"identityId" : "6758f128-474a-41e3-b580-0ea1f333799c",
"domainId" : null,
"createdBy" : "cd08dc4c-7440-4db5-aa76-94657650b65a",
"createdAt" : "2025-06-10T15:08:04.191764Z",
"updatedAt" : "2025-06-10T15:08:04.191764Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 6758f128-474a-41e3-b580-0ea1f333799c"
} ]
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/bbebfc40-ba4e-4b70-bc42-ac2863e3956d' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJZV0pjV3R1S1VHUC1QTDhRNGI4WHFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMwMzc2NzgwLWJkZjItNGEyNS1iMGVlLTY1ZDc1MmQ5MWFhNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MiwiZXhwIjoxNzQ5NTcxNjkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjNhZGQ4ZTAtOGRiMS00ZmFiLWJmNmItMDk5M2FhYjlhZjgyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.c4BWFAzBnsS1qwkezBWsJXZhpgePogGypfLfZi1UFjFS3jlISv4TZK0n4his9wx50OlFJZzeat1m0v8okQXpakASh8Q2JVXE7RkaB0MdV1qpuzEU-hQpshFEalwfhM5BSDRzb0YYRbj2f_2BsgVtatw4NTuKED-3-1KO9WlaS_9C91bpLov_y71PtsxEQKRcsiQzRasuHbZdZYrCj3Pohm_CkQO2OKveR2ZINwvPrEvnzAgvPOWj3YbhpSCZjDDcjNmCEXrwCgJCbp7LSAqH2zp8oCHFxvI8AkJVdntGGCRpsgB1iyfglqV3nRhJA7M5-dV3ep-9IeVBW62xyAY52g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "bbebfc40-ba4e-4b70-bc42-ac2863e3956d",
"identityId" : "896dc3c5-96a5-4919-b892-592394524049",
"domainId" : "37a4e884-0dcd-4d9c-96a4-988576b184b5",
"createdBy" : "db24ce6a-2ba5-4e2e-906c-4ae2067e7de3",
"createdAt" : "2025-06-10T15:07:52.771922Z",
"updatedAt" : "2025-06-10T15:07:52.771922Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity 896dc3c5-96a5-4919-b892-592394524049"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJSc2tBYk9QTzdGZmU4a2xTUll2dnJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE2N2Q2MGJkLTM0MDUtNDczNC05OWRhLTVlZWE1MjM0YjAxNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MSwiZXhwIjoxNzQ5NTcxNjkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2U4YzM5YWYtNGM1Zi00ZWRmLTkxM2QtYmNkOGMzNWM3NzE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfSx7XCJpZFwiOlwiMzdiNjhmMjItOGY3ZC00ZGQ4LTkzODctM2Y0ZDAxMDhjNmZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.We9us3lQX6_HA9eFQuQmgocmyNfo_-VIN1Tgfk_vO3YUvG1Ts9rS7yLByknxHYpfcAhlCD4T5c_buM9x3lDXmrAP8_XLFIgvi5PlCGkv6mhHOtmmQKpWUEubAVj7XbVrfbVlZ7dBLfzMbX9-o6iDGYBlnDovCzJgfNhOFN0bwWwaVa5nSJ53-ry5T8nWR3uf8Rk5V4XpMzMagq9QofSFIlwB8S59t6x1N87sh0Sve0-jtHHltZqM33ZsdG-0F35Nkv76A1sfFBK-waI6f9MqsC7ZZ-dZOkAnWfaoBXp9yf5_kru5qQ-VZS6PSgJbkyVcf1V1K7E_L9MmLmvftp34ng' \
-d '{"identityId":"896dc3c5-96a5-4919-b892-592394524049","domainId":null}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 488
{
"id" : "56527bee-918b-4fb8-95f7-410baeddf14a",
"identityId" : "896dc3c5-96a5-4919-b892-592394524049",
"domainId" : null,
"createdBy" : "167d60bd-3405-4734-99da-5eea5234b016",
"createdAt" : "2025-06-10T15:08:11.912911Z",
"updatedAt" : "2025-06-10T15:08:11.912911Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 896dc3c5-96a5-4919-b892-592394524049"
}
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/25a271eb-7370-487e-ac98-0b6a39b10911' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJacURBUUNYbmg3aVp4QW01OHZVT19RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcwZDRhNTM4LTFjYzAtNGEzOS05MTg0LTRlNWM5Y2I5YWUwZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MiwiZXhwIjoxNzQ5NTcxNjkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTRmZDEwNjMtZDMwZi00ZjdiLThiYzUtYjJiNzFmYWZhODFhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.aduFwxWb6kU461Xsdvzb-tIHzYzyvs7NsTrhJacOPszyEAysVBjnOHBHJDhQ9lHZ9oL1JkboS0zneOksvzT4xlz0FNqJeuR1BAaMD0tts6jIvYxQ2YA7Oy_ST-BSVHCfUjxC44jaXNc24JlVzr4LlUaA8-xJJ0ljG9wEKNpqrRtJnjKYZUzwfh3I0afmjtSfg5NZmbb9AbaTS779MdHHhYLIgDx3nVST7JHyrbh1H2W1LbgzNYxGZmZjafpoQALbV1bqVeCxJhoBL3g3hbhpo17cIUWic-OwhvXrRkrruQosiAgIUNJv4TIqOKQ6t2orwa1J3_FkxxIMIFtOj5L8Mg'
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 |
|
[].type |
String |
true |
|
[].anonymous |
Boolean |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJkQ3BscVR5VTc3T0djSGlaLXMtUTRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ1NmMxOTY2LTkwNmYtNDRhZC1hNmIzLTg2MDBlZjgyOTkyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OSwiZXhwIjoxNzQ5NTcxNjg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzdkNWNjNTAtMDRjOC00M2ZkLWFjZjMtNWQyNzQzZjYwMDM2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.hsKTl3K9s6ErlylZVAlDt2TTyVn6s6DbkHjipy5hQtSL6p7N--yZkUPtDrQfoaEo0_nXfySQ_8mm3pK-4JWj7rx_YcsbW3eAETHmX3CAglt-uzQGUvriQLwdrl72jTJLtd0_rRxlmIIr5SaXxBaBxLQHmU4oy4jSmq8Ft5sd63knm8N5LedB72vHqeaHFnRtk5cnTT1LW-Pj6_c6jUAH6d07fcIg3jDdG4TjXMg6QKlqTCRBo4c8JRv84g4ZDg1ImVYF8gCvseto8mUjTRrmg5-fRno6oYdmz-kdGv1F99Mo72yFH2B29TOi0q44_3Rwwe6ve0XRRUZAtiwBGHlGog'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1467
[ {
"id" : "5a8976eb-b116-4d6f-a81f-9052898e8cc8",
"resourceActionId" : "37232e40-87e2-4c3a-98a2-8ff73cb1e352",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:36.317516Z",
"updatedAt" : "2025-06-10T15:07:36.317516Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Read Resource Type, All to All Authenticated Clients"
}, {
"id" : "6219cf60-0cf0-4bd9-b11b-b5f8f1164d6d",
"resourceActionId" : "9a8e91cf-c419-4acc-91a6-929c1fe144ac",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:36.314027Z",
"updatedAt" : "2025-06-10T15:07:36.314027Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Read Domain, All to All Authenticated Clients"
}, {
"id" : "776488fb-bfbf-4611-ac63-4308a171e05b",
"resourceActionId" : "c399e1d6-f8a9-4669-aed9-1ce3563545d0",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:37.700654Z",
"updatedAt" : "2025-06-10T15:07:37.700654Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Read Network Version, All 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 |
|
type |
String |
true |
|
anonymous |
Boolean |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/80d222d1-2ba1-4454-bbcf-5dad1a588890' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJtVDJBYTBaQkpQY0lJVWhGN3ZadzhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYxMDdiYTI4LWIzODctNGRkMS05YjY4LTFhZDkyNDE0MThhOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OCwiZXhwIjoxNzQ5NTcxNjg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZmRlZTExZjItOTQ1ZS00YTM2LWI3YWQtYzlmMGNlYTJlMWZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.atH4sF5zgRkv59SM3V8bPFF6tO_zsBll_qrPKgoiwoQYQvbvsUDJ1tivO4vq6kEzTegjIWkgptCmeSYJreHUb90SmWEQ34fwjLTHyCzaw8M-EtGPTkgwsfpIA5FtPWbWWktR2swyV5NXv_NL7rXk4SKc1gCtGq9xmItIwBH_gKdOccWmqGOMCKd9O6kgfdptGr9wkbsVQu173_wCFJtqj-O_-NjvhWXOl9cR-00BWEsRU-MT5mVlOhYNRIctoE18SlUC8oizOdGwJxPDnVOUyhEBTv1p9bLxhirc1_0Cqm0L6JBM3TdcBshKOCTrelk_iUIezGPG--83LhDr68b3Pw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 678
{
"id" : "80d222d1-2ba1-4454-bbcf-5dad1a588890",
"resourceActionId" : "e3f250eb-5609-4b65-851b-06235dc68c27",
"createdBy" : "52212cab-c1ad-46c6-9921-a82c16408285",
"createdAt" : "2025-06-10T15:08:08.506261Z",
"updatedAt" : "2025-06-10T15:08:08.506261Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "daa3d925-10e4-4bb4-8c16-7523e64bf1e6",
"resourceTypeId" : "3c3cc05a-3f8e-4590-a939-ee08dfdc1a9b"
} ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Test Action 46 Test Type 45 on/under Test Type 45 daa3d925-10e4-4bb4-8c16-7523e64bf1e6 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 |
|
type |
String |
true |
|
anonymous |
Boolean |
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJuWGt0Yi1zRXl3N2VjWU5GQ1p5U2hBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhmNTczOGY2LTdkZDMtNDQwNy1iMGMwLWE4YjVlZTYzODkyMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OCwiZXhwIjoxNzQ5NTcxNjg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTc4Y2UxNjUtZmYyMS00MTQ1LTlmMjgtMDdhYzEwOTNmMTI3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg4fSx7XCJpZFwiOlwiYTRkMDE0MzItOTQ3Mi00ZjE4LThlYjYtMTQwYWVhOTBlMDhhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.MaEDdB7Z_s8EXqn8kMQ2ukUW_Jmv0ncQe8sScQjXefFwIO0Q383Lmt8vItXGgd2JAKV6Wh2lhNQRsZbQO0ZnrYNRMO_L05agl91xi6DKT65OaYTFoY4ca7G9YBamxm0sq8rQdHo-rNhQPYB5Oe2p8r--2zdSHIC-dqSXQmGWf_vC0Yp7rZrqi5FzQfEITl_srBxrNvROhzZmFFab80jWBwmTGrJpcyegpNtfhfW7ZEjl3JXqMeU-fP4B7LKGFgJ0GNnP_U_-ytpfKzaCJAUFIjklJX1gRc98kJ7ywc9SM27_-mQ88qlnqP3ywAsGh8QCh11pvROQIOUWzkt6zC7xYg' \
-d '{"resourceActionId":"80fc2188-f838-42b7-87c4-bdb003df9af2","path":[{"resourceId":"25655bd3-aba1-42ef-806a-16ca82207b1d","resourceTypeId":"a7b4bee0-5831-477b-b3e7-ea1f7f10f0da"}],"anonymous":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669
{
"id" : "c269e6f3-a276-44e0-b5ef-c671bf2b8030",
"resourceActionId" : "80fc2188-f838-42b7-87c4-bdb003df9af2",
"createdBy" : "8f5738f6-7dd3-4407-b0c0-a8b5ee638922",
"createdAt" : "2025-06-10T15:08:08.832805Z",
"updatedAt" : "2025-06-10T15:08:08.832805Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "25655bd3-aba1-42ef-806a-16ca82207b1d",
"resourceTypeId" : "a7b4bee0-5831-477b-b3e7-ea1f7f10f0da"
} ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Test Action Test Type on/under Test Type 25655bd3-aba1-42ef-806a-16ca82207b1d 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/a96de0fb-0720-4aa3-bc8f-d81745f95be5' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiI3N1QxUzM5U1ZMR1BwV2M4NGJjMVh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ5MDgxYjhhLTdhNjgtNGUwZS1hNjBjLTEwZTk5NTg5YTk3ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OCwiZXhwIjoxNzQ5NTcxNjg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH0se1wiaWRcIjpcImE5NmRlMGZiLTA3MjAtNGFhMy1iYzhmLWQ4MTc0NWY5NWJlNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzJhOTk5ZmMtMzliNC00NTQ5LWE3MDItY2NiNTc4NmM2YzQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.cR9pNUAqUpH2CW4tk_89OaJYONd_QNdpVwZRwg-NtAShq99enSd9XoGOSJ2MzAUK-X8Nw-2HhVQ4NVX6HSAjlpzSAhxL0iCKybs0Aa01N5MD2Rm2n0_IdL6goEICTOQdnTbNX9L1igaWBHuDs7fbTmo7lfS9Ty3mshI_WpM3c8rs8mUoOUGiaaU-lsj5FQEUxCiNM2YPZ_CdOu2kgtVZ9KPR44rjF3lJZWxjxuI02X83MW1BlxVCpdcxuGDMdUzKtyTFEJ3sunIZfv_voXqXMbzeQZrFOkvb7-9MUduzBeWLi0_rrpQhGXuQ-3I_TC7QU0qLYOxpYphFzLZhu1kLug'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiI2LThJWmJvZ09HWEZlUF9RaXVZeUd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA5ZDI4M2M0LThkMzAtNDZkZS1hZjRjLTA5NDZmZWM3MTFkMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NywiZXhwIjoxNzQ5NTcxNjg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjY2NzgyNjctOTBhOS00ZWRhLWFiZTYtODU3OGMxNjJjZjhhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.bn4JqkB3VqxeNtSZdZRnAzgJpAOyXPqAdyvrcbwxp5kR_MiO8SiRa5FbDx3E-fPgttKvuPkqc9AIutnHAAcXLbev09LPi-cD1WvIFulMH_5TB3j97AUzpMPeURJUUTuJNp0fZdF_h_m1LUONDZcwWdPhwSiPCrSm-Jp5zNOZ_xenPviWaCZswjhva8BdY6Dum7fUiG2xlpXmqIWo7zSuwWDF-58fUUSRwro5ZcW-ZTBnk-1GsbqUiJ8HcG-A3qHOYu6RZp-STAQ5QxDwQSZBAEKNuBHmWgfEoGeQv28KhFgjl1bGBxNZRdAnS9pA7e6ikCVpyXKBkah5mRfauRXMWg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1693
[ {
"id" : "077f444f-9ac2-4faa-b03d-f9891d7cbcfe",
"identityId" : "83d8cce9-1ad2-4ec1-ae23-9d1f3d28f2ba",
"resourceActionId" : "7b470099-bbca-482e-bf99-e5064142dc55",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:36.568488Z",
"updatedAt" : "2025-06-10T15:07:36.568488Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read Network, All to identity 83d8cce9-1ad2-4ec1-ae23-9d1f3d28f2ba"
}, {
"id" : "d0e5a752-d6fd-43da-8210-bcad49fb2a38",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"resourceActionId" : "3ef697fe-16a3-4eb8-aed9-14a95e99e44e",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.331641Z",
"updatedAt" : "2025-06-10T15:07:39.331641Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read Service Identity, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
}, {
"id" : "22c10263-f72d-44bc-bb83-f46132bcb904",
"identityId" : "16f645d6-e5ec-4d27-a542-64891f58b3a8",
"resourceActionId" : "eec82667-db92-4d01-b8f7-1ce76cab5d93",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:38.512811Z",
"updatedAt" : "2025-06-10T15:07:38.512811Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Update Network, All to identity 16f645d6-e5ec-4d27-a542-64891f58b3a8"
} ]
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/38fbc69e-5138-40cb-9201-8c6e61b86eeb' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJHTFh3cTdBMEdrYXFXbUxaRjRlNWVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZiNjBjZTkxLTIzZmUtNDQzNi04YmExLTE1ZDhlMzJkZmUzMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OCwiZXhwIjoxNzQ5NTcxNjg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGNhMGNlODUtYjlhNi00MGVmLThlM2UtMTBhMTIxMjBlNGU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f3h4vN_P92eNn8TufR_eeBuujHpyRXW8Bd7vg_ANxvnzeqtVf9qUYTPHSnnb-I1jCKKuqF42t2R_q0i4pAJNyol2O4qFaFPXcpWZLJYtH6fdZNkN8dhr3IvS7B5YQj5X_4ypobMXMpIs_paQNbrUIjpEc6XULlxBTbGRnpRI32QKL50WUy2C0mecQTPnEmbMs9yPsTfzsz5dl0jnYjUlGZRN8nVkzas-CbSBdOzLu3V2BHVFn511h-m36LREENydEW9oHY7Pz-1oPEcT1iW3UUHeyE16Uv38J8vo6sUIWe-H5YsTOIZZLBE1n4r7mKpYWKzv8yFsJHrcuMPazhChsA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 754
{
"id" : "38fbc69e-5138-40cb-9201-8c6e61b86eeb",
"identityId" : "1b954870-d6e4-4568-b0a4-6f3f48e481fc",
"resourceActionId" : "4dd19d97-64a2-4452-b097-c41d24accdb8",
"createdBy" : "14362ff5-9473-4f0c-9924-525962d006e4",
"createdAt" : "2025-06-10T15:08:08.137547Z",
"updatedAt" : "2025-06-10T15:08:08.137547Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "310ce0b0-d705-4dbf-89ce-3213075c7591",
"resourceTypeId" : "0018d0a2-095b-45f1-9983-7c3bf2c939b6"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action 43 Test Type 42 on/under Test Type 42 310ce0b0-d705-4dbf-89ce-3213075c7591 to identity 1b954870-d6e4-4568-b0a4-6f3f48e481fc"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJ4bktPeW04ZVpOZEJJNWNZVU5nVEtRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMwNDk1OWE0LWU4MDktNDUyOC1hMDU2LWRmMGExMWE2OTFhOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4OCwiZXhwIjoxNzQ5NTcxNjg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGQ5NTM4YmMtM2VhZS00ZmI2LTlhOGItZjkwZmQ0ZmQ2MmMzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg4fSx7XCJpZFwiOlwiOTczNzBhMmEtZjZiNS00MTA4LTk5NjAtNzY3ODc4ZjdiYTFiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Imt8T1n71j2UYNY7-BmG9Qbm19ytrymBcVqOCg7utNJOyr8jJs6Sj-_xXgOp3_AVJuTmYDAjRzJwU2uZm3ssm1-23I8jw1WoLrOLWkYLg87HmNAsoWKIekCJ86tvz170-9ERW-EQo2yx_DYB7q5reE8GMckCCbSCJGzVqXejMaCZMiILOgQaYQhiwD5R_VKhdS28dS1as6xMDF4dFhTJa5BAzApAuOWZe8E3sHGTNA9loFmZepnzCLIsFP-QaOVnrLKazSDxvGyfokctomE5KuARq5ftk3m1eTerHF-yCSBoqrwB4AHBCMByylCxFMGwgdXK1ubGzXWxsZTM-dT47w' \
-d '{"identityId":"fc619ba5-a404-4311-b68d-8895e5b9b98d","resourceActionId":"80fc2188-f838-42b7-87c4-bdb003df9af2","path":[{"resourceId":"e23a1b71-a765-43e2-943d-0957924b365a","resourceTypeId":"a7b4bee0-5831-477b-b3e7-ea1f7f10f0da"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 745
{
"id" : "90194a50-0e49-4579-a421-34a8decec023",
"identityId" : "fc619ba5-a404-4311-b68d-8895e5b9b98d",
"resourceActionId" : "80fc2188-f838-42b7-87c4-bdb003df9af2",
"createdBy" : "304959a4-e809-4528-a056-df0a11a691a8",
"createdAt" : "2025-06-10T15:08:08.359364Z",
"updatedAt" : "2025-06-10T15:08:08.359364Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "e23a1b71-a765-43e2-943d-0957924b365a",
"resourceTypeId" : "a7b4bee0-5831-477b-b3e7-ea1f7f10f0da"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action Test Type on/under Test Type e23a1b71-a765-43e2-943d-0957924b365a to identity fc619ba5-a404-4311-b68d-8895e5b9b98d"
}
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/909ecb21-a9cb-4f0b-8596-844611b876a5' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiI3SGxHM2VVcmVadFRwVVgzUVJwdFNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgzNDVkYmFhLTYzZmUtNDFmMy1iNjM0LWQyNzEyOTI3YzUzMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NywiZXhwIjoxNzQ5NTcxNjg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzEyNTZkMzYtZTIzZS00NWZkLTlkNjktNTEwNzQwZTMzMDI2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.2hpBVnZ8n9Yc3NZB3LS7QmlXLgBPxIX6uPeD8VAf8dmP1N5954NPPLjUlADPrDPMAaEfqEf0kQ_Xx5WNdgvv7Usr6riykIGdy81c7AOnUSaS25G6-EF2wjGyOB5hI0ki4ZEn3xH3lvBRGKhmmwt1GViZI-mkKoYPShckuteR6fcpj9kW8gDjyfgynYC9MS9gbZvTJith3ummAK_OmmAwLjjuIgy-SVwMde-Pncx1_CtGAdzSShRSNDaoMiXoDuVPEGIv1WNtVGpCkGBq7soMq7890dAOJTabyokHI6hp7Xm7Sd6e-BG3AUsKTQgHKFamg0JrIf7xDPiERde-ktsGWA'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJBM3BheEdVN2N1Ujg0Rm52TWxicS13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRjZmU4MTNlLTBmOTQtNGIzNy1hNDNlLTdhYmZkMjg1MWMyYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NSwiZXhwIjoxNzQ5NTcxNjg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmUyZGU3YTgtZTJhOC00NWE1LTlkYTQtYjk4N2M3MzBkOGJiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.REye-LTp-GZRtcnJg93SUTU0EnOFlp1ocEhDSao4S_UufUoHdjviYErSQ6_stXXM-RAQOZ5y-HrKOpq5uZUJj4dfgwBhEGqJoiQ8wjlbaBAP2CnW_YBblhGDOk4e8I_orhxtwINfjB7vUO1LCW5p-GVWZde7agZyAZvOlfveGqrp3kZT1j1NznGAVwsR6Pyz9R8KKP4azbBJBCHCNE4Bk_3Xt2IYrS0NgP2R5sS7rHI7GU6Ouo5W7xXB7WG9KsC620DwEsMz-VOiKOM7ZM-sJl8i_Gs6xAQ8RWm8W8O3WNMPaQoF-X80YuDS4SXR-6h9gvorQIpTr7HwoHukWonZsg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1153
[ {
"id" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"name" : "NF Support - Intervention",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.456451Z",
"updatedAt" : "2025-06-10T15:07:39.456451Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "NF Support - Intervention"
}, {
"id" : "8f1493a4-29ca-4b34-8d04-b6ef954b097c",
"name" : "Cloud Engineering",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.650930Z",
"updatedAt" : "2025-06-10T15:07:39.650930Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Cloud Engineering"
}, {
"id" : "1098c1bc-676f-47f6-86ca-39493eeeb8b8",
"name" : "Test Custom Role 22",
"createdBy" : "d96e5a08-983f-4466-8e54-a24db0faf832",
"createdAt" : "2025-06-10T15:08:04.427898Z",
"updatedAt" : "2025-06-10T15:08:04.427898Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Test Custom Role 22"
} ]
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/423ea525-737e-4366-bfe7-0ffe6a416832' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJYWmVscVM0dVl2ZG14R2hkQjM5NHZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhkYmFiN2M1LThhYzYtNDIxMS05M2VmLWUxMWExZjRhMDlmNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NSwiZXhwIjoxNzQ5NTcxNjg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOThhZWRiNmMtOGJiNi00MWZkLWIwMjItNGE4ZTczY2YwN2NmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GqPCGFSPNnEzHg7g2GLiVAtAeCobxiZhCV1FSfazuVQjDESFOucLD6rFZ7rax7obe-Di0N2J9qop968ho7x0ISYbCSehhF38BpAbu9JHL_rBYmILw0fp0P4V34430-eu1JPOiKPk2C0mo6eRy9XGxYTrQf9FOhf7vuuaFGRE_ouKG0EU-GkkOohCKDuZhRUgTSC7c-ghaWdUDbLE2yKqoJirdbUNEMyX3zCxQt7VB83VUP6ZchOxgaawzNEEW_smzlbw9Ip1M5VbyRcEcoQoN9w81B78Ln5smAq0uENRP-NHnqXz1s5uB31E4PWMbqMSZyTWcuXt7ST8BWLctByBrw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 379
{
"id" : "423ea525-737e-4366-bfe7-0ffe6a416832",
"name" : "Test Custom Role 31",
"createdBy" : "cdc816fb-03d5-4330-bf0d-9034ffb13de5",
"createdAt" : "2025-06-10T15:08:05.387619Z",
"updatedAt" : "2025-06-10T15:08:05.387619Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJjcnZOS0tUdTd5UTlQY3BpLU9zNVp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA2NmZjZjdhLThlOTUtNDUzNy05NGM4LWZjYjFlYmE0MWJkOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NSwiZXhwIjoxNzQ5NTcxNjg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTRhYzJlYjYtYmZkYy00N2Y3LWEyZTktMjI3MjJkOWMwODZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QZmjBm3jdp4sTivFTuR_m4kzNR1lIWWlkTHRCt4o6oUsIC3q7GjRnXbbNAmjrDFF4gqEj6zv1YcVgA7Jiv98MYGeyqhUDFBF0sUJHiom8T8TyMYBb8EMpfJo9V1SOjcVzSXS9NEuEpLuS9O8f-SGuPhspbg_LMrNPVx2J9DrrXSSKvmXq9s-UaXdTRs1KSsYFXtPT_7DgpDcHdo4xgyX_1amGVKFG_dWBkjD_nZLiLvXzBqv3chBrpOhrBEcPtb5RQ56tMkaUzF3ymGSsaXukc_KYZq3pIkyBWbrLMaZXmm3hNakKgpvs8SzJJCJgiH27D_BAATKfdFOtnFJnvWA-w' \
-d '{"name":"Test Custom Role Create"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 387
{
"id" : "743ac33d-ed84-4281-aa22-50b23c95c8aa",
"name" : "Test Custom Role Create",
"createdBy" : "066fcf7a-8e95-4537-94c8-fcb1eba41bd9",
"createdAt" : "2025-06-10T15:08:05.967220Z",
"updatedAt" : "2025-06-10T15:08:05.967220Z",
"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/f46c63a3-55cf-4825-8bec-ee62f29aa54a' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJuaUtIYVdJSThuaXk3UVhOazM3LTZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI2MGNlM2E3LTE1YWMtNDU5ZC1iNWI5LTc2Nzk3NDYyYzllZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NiwiZXhwIjoxNzQ5NTcxNjg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDFlNzdiNWYtZGU3NS00NzBhLWFiZWYtNjQ0YjQ4ZWI2YWUzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.YHDcrFIFKKc7beFEoYIpP_i7zgPl3iJDPUbjqZ_UJPauqfkTnTD_sX_elFzcCiI2WjWF_JafFh83hsubl5ndnev_ir1sVJiQyNbSR4v1GZCDljZmbHKh1jGZoNHke7ODpMKI4qzB1bsqOrUdRk3WIPLmccBoXhmpTVh5sMYfkKI341uv3t5yh87m4LGcgNdvZl_aSABohugTxQMvwZiRPhxuDNvkIAZkDW3k6401oohQTHPi9RMGrPTIV6q_BKtDxbCDRpkCOoTJZVv8kB3RSulXMfsw9nXXnAl1Bgga3t79k5AypNc4ljCMKH5r9nNexX4mt9pqtA5crPbkGp0OUA'
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/b84cff40-d705-463f-8ee6-efe4f1ae4e4b/identity-grants/da7f11df-ce21-4257-aefd-241d92af27c2' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJkQ0tEZU1pQ2dKYUZweEtKbWhweGhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI2MzlmNmMwLTMxYjktNGM0YS05NGFjLTUxMGVhMjY1YmE3OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NSwiZXhwIjoxNzQ5NTcxNjg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWMyZDdlMzQtYjFhYS00NzlhLWFhZWQtNjE0ZDc2NDA3MWFlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg1fSx7XCJpZFwiOlwiODc4ZWQwYjYtNGMzYi00MDBkLWI4MjktZWVjMzYxYzJlM2IwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.I8aajOrgCjdmSCh1pS-I2Jq_i4jbaqn9Tqf6jpZBBfXSOf9GM077o_Yz4LgkjXyFQIAFduGuje-ThTePMhiqTJp2yEEANmDZnqcxrtrfeEe3kf-JbSgilzuNL-US8x5VIg_FmDHF2Nn2yDcQi5-xnkJbiuA7uh3NsY1QTT_VujJQqVnPcBJMmnKu_aNBWeLWZGoceKbEVxIO19ZPcfmOf4BRMzJIsJ3GZoNgzT93LgaxgIzPbdVaXFX2uIVxJRsZTAg_AU98G3YsahvlGH7KPgAG1NKWHO56QabDyowSzT8cEo-v_TcAicxGGWARc2i2lP4oaYC3ULPzktJr600HWQ'
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/c1bb38e4-e89a-401a-acbf-d99cc8cd788d/identity-grants/25c22017-5651-4275-a8a5-3b6372b75287' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJtSEhQX2xDeGY0QkNWekk1dmNiYnB3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkxOWYxY2I5LTcyYjktNDU3My05OWMyLTA3NDYzY2ZmODc4NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NiwiZXhwIjoxNzQ5NTcxNjg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGE0NzY3NGUtNTJmZi00ZDFlLWJlNDMtNDY5MTZjYTQ0ZmY2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fSx7XCJpZFwiOlwiMDgwYzI3Y2YtNzNmNC00OGU2LTkyNjktZTI5NTg1ZjA0MTQ3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.WFb1YVkiOu52AeCIqOCJBd7aMBzb6aQINJY22i7dIjwo4ZSe6-Vv8b7ejoMj2JJho4Fqq-r1XaObyOx_srangVrgWeRg7dMv66_FSvlTUVYqcfr_avbZOWyfPjyEFKSJuRnFn9Yo69te_hzzWpF7pyTU-ZYdXWxKeR6WQKBqugpuFTuUCq8RL0aWQJ2p2378LmFD9AM-Vq0gU3cmJn0GZT1MxkqIPoRQi5KCAGhmEAFobOnJNRJ_2X97haKMKoVXVH6t0q__ZoTJsjUVGcRhM8OCtH-aeegerlCxqrRfPb8WemrySpDnuDzE-xuXhDI0zKD2yFzmVYsE65In_ysj2Q'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJYc3lXX1ZkdEJrNDRuT3dSci1SYUlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc3MzQ1YTg0LTAwYTUtNGMyYS05NzllLWI0MjdjM2RlYjYwOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NCwiZXhwIjoxNzQ5NTcxNjg0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjljODBkYTUtM2Y5MS00ZDUzLTllOGItN2QxZjNiYjRiNjcyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.LFxUYn1ruRPSEWG8PQhz8alyTcMhl_vQCzv8NA-WvMUVNIZnmGk3BmR2pDddbOyIA81T8ggGoYEd1zUtOhpRJyUq-8pDhWvxx-1sB4SrZOZw6mChUeX7A-DSZsHlcR5WZDZD9pwv2KhYLHu8q1oIP7mqSx3vWqcC32DK-SbIZULPTdCqjKOIJD9ivzCxAn_Lmg-aFi3MXwfAuDmzgjX1wJaak7avWa85F4xpS_ndfWRLeB8Wu9yx51Uq3AelxftYFbl2pgnKPZQYLYkWBMMwRymg7f1zYCdWfOfC4FelKMirWrjGR4tGXrSUDrNxgB1Zl0syfN4L7WlmDaCN2xA0-Q'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1309
[ {
"id" : "d34b6b7f-92cd-4069-92c4-ddb7a93a5cc9",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "8edfc50a-7d1d-49e1-bbd5-11d2f4a21c65",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:40.111926Z",
"updatedAt" : "2025-06-10T15:07:40.111926Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Create SCIM Mapping Config, All"
}, {
"id" : "e8441efd-1658-46a6-a3b3-fa2dddd61ad9",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "3eba9d94-22de-44a8-87d6-c9bd0919752a",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.781580Z",
"updatedAt" : "2025-06-10T15:07:39.781580Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Update Resume Network Controller, All"
}, {
"id" : "a4ee0a94-932e-4424-a3b2-81344de74b72",
"customRoleId" : "f1e3d5d9-2899-4df7-89ab-297d29cc54bc",
"resourceActionId" : "1322c48f-7819-41c5-a0b4-9aaa0f4534d1",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.457387Z",
"updatedAt" : "2025-06-10T15:07:39.457387Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Exemption Configuration, 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/0b78a9fa-8d67-4341-8c1a-bd31682fb377' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJqTF9OUzBXV3dfX2tIOTVyYUhoaGxRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM0OTY2NmI3LTVjZTUtNGI0ZC1iZWM2LTZiY2YzNTVlZTYxMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NCwiZXhwIjoxNzQ5NTcxNjg0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTVjNjc0ZDEtNGNiZS00Y2ExLThjOTEtMWU4NjE2YTVmN2EyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZhLq1jVogIzuv2JMvfXPiiKYbYYWEblCzv4KP3qK28s1P3rpEekdPNhlX4IBT7d14znZHGJkp4KXbok1wQhUHywfJ_5YkIkt5_bf4D1VP6E2HKeaFDYY5lEsQ2fNzUA8jKICQm5P8NRg9ZlTnwkE-NZZpAj5N85lO8MNxEusrF08ow9aPAqvZangDiGsTVeKP1IMMfPgWfZxN4UWxG-jRbP7PXvDTAh0h0I98xRCY1NdVfxKHDqrRoLgvKOJU4jY54627jgykw6yNBPUc4BrEI4Af8wUiHfJZMqMfptOgbGlaijKH6g1VLPBy6wRpCfxC-mp-lctEcxxNUUnfvSsOA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 613
{
"id" : "0b78a9fa-8d67-4341-8c1a-bd31682fb377",
"customRoleId" : "72efc3e6-1360-4b02-a312-bd7a0e38bf83",
"resourceActionId" : "8f232348-0a99-4b6c-95a9-3a5712d01fcd",
"createdBy" : "52a447c4-ea03-460f-82c1-5f30b493a6c4",
"createdAt" : "2025-06-10T15:08:04.825825Z",
"updatedAt" : "2025-06-10T15:08:04.825825Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "b4ca08c5-0687-4bea-b060-9831d071e339",
"resourceTypeId" : "42f512c5-1138-48d1-9cb6-069d72eaa6a1"
} ],
"_title" : "Test Action 26 Test Type 25 on/under Test Type 25 b4ca08c5-0687-4bea-b060-9831d071e339"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiI5MXZRcWNyYzcyemhxZ1pUUm5fcjdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIwODIxMDM1LTlmNDUtNDU2ZS05MDA4LWUxN2U0ODkzNWY4NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NCwiZXhwIjoxNzQ5NTcxNjg0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGFiNWRlNmQtYmI0NC00NDA3LWFiY2QtNDliOTg3NmZjNTU1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg0fSx7XCJpZFwiOlwiNjEwYzMyNmYtYmQ3NC00ZDZkLWIzY2MtZjIxYjBkNGY4MDlkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg0fSx7XCJpZFwiOlwiMTJhMzhhMTItMWJjNC00NmQ4LTk1MjgtMzEwYTZhOTkzNDdiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.dEWz5gZvZ0o0Hvv0U6G4R26iXpiSu-NccJka9-Asoysv6Ogs-kzIO0uP7BVR8neHlkA6WxTx4fgMxJvXpUjGwYA2XPdWbon5uVPmPAkXQA4uVMwElhNj6SfRxL0N36RePwCUXIkx726gnRPpeK8HXCbvxGQWtcVXkWOz_GvH8RqfVUn5ziFuxC2tVuuL2Mmv9B4VxltM2CtoknR4q8ccDx5xRsHZPtEJ_-F9SoQcyZP-pE55AZYEn2lu7Z02onGkBaCeidfvVBqApum2uksm8WcJM5lW-WQg4z9eKTrLxWWXCD-P3yYhTlYHUqzlgps6brjR1zJt6YnakXIPvWDuJA' \
-d '{"customRoleId":"1098c1bc-676f-47f6-86ca-39493eeeb8b8","resourceActionId":"80fc2188-f838-42b7-87c4-bdb003df9af2","path":[{"resourceId":"80e6bec5-661c-4e4a-8aad-aa412696cd55","resourceTypeId":"a7b4bee0-5831-477b-b3e7-ea1f7f10f0da"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 604
{
"id" : "cb3e2a66-ac03-4ef5-be10-585289604919",
"customRoleId" : "1098c1bc-676f-47f6-86ca-39493eeeb8b8",
"resourceActionId" : "80fc2188-f838-42b7-87c4-bdb003df9af2",
"createdBy" : "b0821035-9f45-456e-9008-e17e48935f85",
"createdAt" : "2025-06-10T15:08:04.601306Z",
"updatedAt" : "2025-06-10T15:08:04.601306Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "80e6bec5-661c-4e4a-8aad-aa412696cd55",
"resourceTypeId" : "a7b4bee0-5831-477b-b3e7-ea1f7f10f0da"
} ],
"_title" : "Test Action Test Type on/under Test Type 80e6bec5-661c-4e4a-8aad-aa412696cd55"
}
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/4da61838-74f5-466c-94c9-a40bf8ece2e2' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJraEdyaWRMVkE5LVIwekszR2cwSXpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjNzBjNWVkLTA0MTgtNDBmNy1hMWNmLWMxYjkyN2RlOWEwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NSwiZXhwIjoxNzQ5NTcxNjg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTdlNWMwYzQtM2E0MS00ZWFlLThhZjYtMzZjODZjZDU5MTY3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.XE_tHxVxMlOEDNXspzT49ObrCXdMaRBydyVHgK7M9D9AxK1Nnwu_lD62G2V4IO7Zkfcqsy4xwT9ckNC2RMmv4bKqYB4uDI8_fb2WzTEJ4n401EnKH9XiAXPb1hXM-S1CPjDHS0UCrRXOLYcepDP2q1QDdznSz4zOGKFyKI0p2-DsZyGP80FIdAWLLvMS0UT-nAztEIA5LyXwpYMg46thoZ44dyjFm1Hex8SMOcyNsg7ayUcQSjbfchGpzZK1El6x3lPiyrSxRqxafoTsaDXzcoRsOFK8W3MJxRwC1pyWccOgh_QilAl0Z-VFvc9HVB_DVXWdmoEaFt4CyhuKHxSp-A'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJKekZvc3VsRnZsRm9pRU5ELWVfb3hRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEwYjc5MWUxLTliNzAtNDNmNy05ZjJhLWRhNjVmYzI5ZGJiOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NiwiZXhwIjoxNzQ5NTcxNjg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjQxNjJlNmYtNmE5My00M2I3LWFmNjEtNjVhMmEzZjkyOTNhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.sTirHtyXhJcsvP3YIZi33qMlxJEKMwGEOwNtTzk1tW6_CtomGTfhmGFNoDhW2RrTEPw-Pafcf6Rx3MYEo0QwFhjxV1rwZwewm0UmQ__b_eX5KsS5RkOSUgmcNDwLA3T0idq1A8TFJFTYIMiUBmDZH8DXGMNx1vi_qoMwcfjCy8SoM4ucQLmAAdmDHwjgT5E09emQMelONdEzYHAzzrQhXGyBrDh32N-ysU6Nm36jkb1rCqY6dk5QOvXI9if2afuD_Mw8cZ25C5u8HjDqKXlxAJp41g5QTAS5o8_DfhPaVcc5pdeSfdVTtDExdS1QPsbpnixG3spQGBOCjXwFylCaUA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1415
[ {
"id" : "26188235-1463-4a4e-9778-ab43881cdd8a",
"identityId" : "8c86e52a-f2b1-426b-aca8-86dec4ebed48",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.635863Z",
"updatedAt" : "2025-06-10T15:07:39.635863Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 8c86e52a-f2b1-426b-aca8-86dec4ebed48"
}, {
"id" : "a4f07759-8431-4bfa-935b-fc514c920575",
"identityId" : "373cef0b-d1d8-460a-9aaa-373a63556a5f",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:37.290874Z",
"updatedAt" : "2025-06-10T15:07:37.290874Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 373cef0b-d1d8-460a-9aaa-373a63556a5f"
}, {
"id" : "bddc8010-f420-468b-9c11-96dbb97e7299",
"identityId" : "e5f14eba-5792-4a1a-bcf1-9fa176637dd5",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:36.187892Z",
"updatedAt" : "2025-06-10T15:07:36.187892Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity e5f14eba-5792-4a1a-bcf1-9fa176637dd5"
} ]
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/df1b3912-3e4c-44bb-9b69-2defbbf18097' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJYZHB3NUZJWm5tMGtHRjN4VDBXT0ZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM3YWY3Mzc2LTVmZmMtNGJlZC1iN2VjLWYxNjdkNTc5NTkyZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NiwiZXhwIjoxNzQ5NTcxNjg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMmM4N2VhZjEtZDNiMS00NjIzLWE0ZTktMDlhODJjNzZkMzgwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.F2dlo9tse9oN4WWjL4B4-EjuJFiX5-I40FefkNsm-NbAzmpQ7IhA3ozs3Eip8WYh2KuchCVQd0BY1iekB7G0m0EQmWlmCoU_cn-CtQbHa9fBsb2zd2TRzgdqGFDhiTfHG1gGyKEGgeBa76-xUcfJctTLMlkP-GUk0xYPL9dbMAycP6uMOkoVj1p-PMvMbwt6j6MlqaSGVnnaWp3IV1f95VI1AuiT_HyLVN9QNkwNSyrRfU1A2BQT0z-u1KjES7dXd4Mf6HPgdv1oXDIX2rYyiestZ_xF3aJGETydY-QADN4v9kPvkBN3HXiJW2M8HvSvPQsPTgTHup0VKOSgZEXF-g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "df1b3912-3e4c-44bb-9b69-2defbbf18097",
"identityId" : "24959655-b582-46ce-b96a-53a8e6253b4b",
"customRoleId" : "c55424ca-aa40-458f-92fa-6741729d2fd5",
"createdBy" : "ea0737fa-eb7e-4afe-8f2b-806872fb495c",
"createdAt" : "2025-06-10T15:08:06.336217Z",
"updatedAt" : "2025-06-10T15:08:06.336217Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 35 to identity 24959655-b582-46ce-b96a-53a8e6253b4b"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJwbXhOM2JSV1lXRG5hRGo1QXA5Z2hnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMyZWNiZmI2LWU4YjAtNDJlZS05NTYyLTVkZTJmMzIzMTgyZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NiwiZXhwIjoxNzQ5NTcxNjg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTRhYmM5NzMtODA1YS00YWRkLTkyOWEtY2NkNTFhNzNjNzZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fSx7XCJpZFwiOlwiZmQxYTZkYTktYzJkZC00YzU2LTg4NjktMTBlNWFkYTZhNmU5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.K0Wcd3Zh89Xm0QxkTrhihYtwgy-9iHzGySCrNhUv3pHdyq1yigxeKGGZ6r5LiNebhgJDVgrhCVhErNEzhelj3gBM1zky2qDp4E-5Mj2pSgq4l-92tlL4L2qUi2UuCJxSWY72B7F27h3C1oO2Ulv0nmWnRrCy9IW02wSFlfiy-_QgfOq-5yCkv2MTqo4wgGxZYDTB1x-ew6pAoy65WACc86W5NtuqIZ-ETpVD28V3xPGQw2MBtgyVgjEvRIVZkAsPHJQi2Vh6RDFBrsCVM_lnYya3Yz63SZW4Qr3wXlihhVylQhABm1shT2HCC-_tzkylozZQ8qJ_gravsdu3-lI7kA' \
-d '{"customRoleId":"50cb349d-c343-47d2-8431-b7b6d9bf79be","identityId":"bf66dd9e-c145-4d31-bbc0-aafe68bf6160"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "2044ce57-51af-4d7f-948d-17320e427870",
"identityId" : "bf66dd9e-c145-4d31-bbc0-aafe68bf6160",
"customRoleId" : "50cb349d-c343-47d2-8431-b7b6d9bf79be",
"createdBy" : "32ecbfb6-e8b0-42ee-9562-5de2f323182f",
"createdAt" : "2025-06-10T15:08:06.648887Z",
"updatedAt" : "2025-06-10T15:08:06.648887Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 37 to identity bf66dd9e-c145-4d31-bbc0-aafe68bf6160"
}
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/09203799-8520-4964-8b84-7c4942a89edc' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJmU25RNGFTeUh2bVppYjhWMXVLOE5RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhkZTI4NDg5LThkYmQtNGI5Ni05ZjEyLWZiNWYwNGYwZWRjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4NiwiZXhwIjoxNzQ5NTcxNjg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODYwMjhiNTMtOWI3Zi00MWMwLWI4YWUtYWI4NjRlYzNjODc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.sz1me1qz2QAOvBFLgSbWWvMVWHGb4F2N952nO-SYhqEWHwuVKZnsJqG0uxemhwrsBNdL_cd8ct5gtiOEXFuPZNPqkf7Qj79YpuwYQpc7yILT_n3EPVb6cAtDaicsNr29vfnOvM_yFuq6wGaFzpLNkojnZRsq-H2KvX93CIusOBDI-t7oFNfrOh6qvKnFbWdWtcze5hGU5gOtCuQD0H42FdgvXq8sRU5rG5omVcrZs1CUgjEl6xpVacF342j7fiAxlhrZDSY2poMgoVQLsBmP_2Krvq4U-BnCKQVp6dzacvonuaXJyPyJaOAR-anSQZ2fMmQR6lSzDiPXPDccpcAsUA'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJYTV9Gdjc5Z0RGM2xlWFdJMVpScmtnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMzYTE4M2QxLTRiNmMtNGEyMi1hYzA5LTBhNmE1ZWY4NjZiZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MCwiZXhwIjoxNzQ5NTcxNjkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzI2YTU1NGUtOTE5Ni00ZmUxLTg4NDYtNTI3ODY3ZTM1YWZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.2VWkALGArzM3ddvOtV3b4LGDXFlkk14zF5KuMwW2fwXjxNJ82cP6Km6v6HnCPm2sjcCpopGi9Fb5EboL5JE8INIdrLD7xZ7nXuC1wMBnSgYTXtSWqGxgyvv5Go2VV54kqi5WmYKG_Z3qGaEY3LUxQmQDBAUqHocm77XN6rvjVy3H1q6qHX3yLW0msQF7qzUxIZ8a3JvWvpEMu3EpN64El8EeCAB941ZVkPzgdCn49YqRTRY-UqXniBzRMoXwqSblWGZsifcZfbKvyoCBDeBlrcDiT1ZJdk8h6vHnBUShaHFDo5nXWcibXZwc61zc05zYMcgz_ceARUK8uJ_flSdAZQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1795
[ {
"id" : "93fadd79-5244-46f2-b217-0fa4ba9b6721",
"standardRoleTypeId" : "9b81d638-0875-47d3-892f-dc68cccbc45f",
"createdBy" : "a2245fdb-2633-40e7-a299-6b6fa01c2481",
"createdAt" : "2025-06-10T15:08:10.458849Z",
"updatedAt" : "2025-06-10T15:08:10.458849Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "51ee58ec-ba32-482c-b1e4-ca8f9d62b095",
"resourceTypeId" : "3fae9cef-5fdc-4d05-8260-c5f51b0c45d3"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 55 Admin - 51ee58ec-ba32-482c-b1e4-ca8f9d62b095"
}, {
"id" : "b75be358-a3f9-40a5-972d-a804c4758041",
"standardRoleTypeId" : "1ca9447c-2e3f-4f54-b400-5010f9f3a687",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.651994Z",
"updatedAt" : "2025-06-10T15:07:39.651994Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "bce07cd1-8f36-44a3-b279-26426e7a53ef",
"resourceTypeId" : "1524aa37-b61f-4408-9e2f-b624c3693c4c"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Network Group Admin - bce07cd1-8f36-44a3-b279-26426e7a53ef"
}, {
"id" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
"standardRoleTypeId" : "1ca9447c-2e3f-4f54-b400-5010f9f3a687",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:39.516227Z",
"updatedAt" : "2025-06-10T15:07:39.516227Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "f0428619-11bd-403d-8b00-a463ff8aad84",
"resourceTypeId" : "1524aa37-b61f-4408-9e2f-b624c3693c4c"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Network Group Admin - f0428619-11bd-403d-8b00-a463ff8aad84"
} ]
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/fb8ab3a3-bc8c-4f7b-8a86-0a3216d0fbe8' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJMUHY1RFl2bFNjdHdzdFpWS3ZnNk1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVkMmEzYjE5LTEzZTQtNDE2MC04NDMyLTE5YzI4YzU1OTY1NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MCwiZXhwIjoxNzQ5NTcxNjkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDNmMWM2NTUtNGVlYi00ODIzLTljZDgtOGY0M2QxNzAxY2I1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fif7FJc4FRIgy8YQVfAsMQeRFlMXykDImB37OeW9Rpf8DG7sWT-wdL1m0ROMN6jiyY97OcafPe5IWycW3886elHfuoFb3s8zR7n0-hVHDeo1ZT5iR_DPg13eHkCzxJRRFNkkObwuni1AETUXFlgtoakM3Fd5zkiE5xzsc4ZT1TeZJDhRyKJ2FqfHOeEaPC-PLO5qMkdEcRUxuMhhceDZM-V9i6PgQFtId79bm8Udn9ZPaT4-5Y5e-jHfr9k4odJMDIXtlNJXobBsqX_wEC7O5_n6k7Vhx1yFq1CG3BRPQnTRuSsx76QE_ZAxLD6Tbzp2DuXJ-3AcZeR4IL1wRM_ywQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "fb8ab3a3-bc8c-4f7b-8a86-0a3216d0fbe8",
"standardRoleTypeId" : "504544f0-55f3-46ce-bcda-d1e421622c51",
"createdBy" : "8ad62bac-9e51-4074-a45a-8e71102f38b7",
"createdAt" : "2025-06-10T15:08:10.298807Z",
"updatedAt" : "2025-06-10T15:08:10.298807Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "a9c3deea-7af2-454e-91b7-c64082154759",
"resourceTypeId" : "e328e0f1-9277-4249-97ce-ec4ca6d04436"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 53 Admin - a9c3deea-7af2-454e-91b7-c64082154759"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJpOHdVZjBrNWhTNGlrb2puNkNRdnpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEyMjQ1ZmRiLTI2MzMtNDBlNy1hMjk5LTZiNmZhMDFjMjQ4MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MCwiZXhwIjoxNzQ5NTcxNjkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjljMDIwNjItNDU4NC00NTdkLThiY2UtM2ZjN2U3NGJmM2ZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkwfSx7XCJpZFwiOlwiOWEzNTU0Y2QtMTQwYi00MDMzLTgwNzgtNjk0YzI1MzNkZDA0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.SNIM0aALbvBLEaYDDX8-2AloBbYN_WwkCZQit2ZJMSro8vwvsMtaPyTUmLJt-TGNVxmsxkLOQigXMYZH8TNPr9EitsBjgPTIvMKBnV6_by9BOjNTpPKogBLLlrAUL65tbdGMAKiLZQdBF_N_UCBPxfXKRuI9isUPetgfATvb4myD_xsYZ9pVDVf3gLtyGwr3pLfHjXIxMrtRcBDLDjwfnQnONyGOFzkB6fdK_WpiPbjz-RaLZXWvL1EDoJ06ZRsIjpRw0XOd8ltxCJQIFIve3TFe6OLLTxSTNUxkMucU6RL7sSwSEra_ppTNTNJvsf274hCGV9qi8wS-Wupa5zAuIA' \
-d '{"standardRoleTypeId":"9b81d638-0875-47d3-892f-dc68cccbc45f","path":[{"resourceId":"51ee58ec-ba32-482c-b1e4-ca8f9d62b095","resourceTypeId":"3fae9cef-5fdc-4d05-8260-c5f51b0c45d3"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "93fadd79-5244-46f2-b217-0fa4ba9b6721",
"standardRoleTypeId" : "9b81d638-0875-47d3-892f-dc68cccbc45f",
"createdBy" : "a2245fdb-2633-40e7-a299-6b6fa01c2481",
"createdAt" : "2025-06-10T15:08:10.458849Z",
"updatedAt" : "2025-06-10T15:08:10.458849Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "51ee58ec-ba32-482c-b1e4-ca8f9d62b095",
"resourceTypeId" : "3fae9cef-5fdc-4d05-8260-c5f51b0c45d3"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 55 Admin - 51ee58ec-ba32-482c-b1e4-ca8f9d62b095"
}
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/554173ed-76bf-4c1f-a0a3-11b84387c6d9' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJYZENwTFpvMGpjSkNWVzQwMGVXQlZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM5MTVhMDhlLTNjYTktNDcxOC1iNDc1LTdlNDVlOGVkNzU5ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MCwiZXhwIjoxNzQ5NTcxNjkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmFkODk3MmYtOTJjYi00YjI2LWIyYTgtYWYxNjAzZWY0NjVmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.wwrKBz4v3ZGyhREpMp6lX7SfaqztHRYUXadK6idaD2ztbcqdiERsH-oz8L9TD_jiz4EA-d_bCscwaGSVPVNkftZqkbl60MhfPx_13T9V2Bw_Dl_SYX9NE7fMbQdj91Kz9faLxt8mAPZAclY0QvxZfGBfvQxsB8-4zfJQpi0UJ_dY9Snb3Y6CLYCZPSJ1u6ddBjMbX-_rwz57TtgzczZOrz2UDF094kKFtl7MsHzf7kjO-4uv7EHV7S9H2My5_d59_fp8wZh4TZxyPHHXC1TS5gVNsVlllldGU4K2SpC0__2iXJaDQNTjswGrvZzZVcD-4WG6k9RzbsZ7xs2JsvqqUw'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJtUENBWlFhYXc2U0RQZl9qVHpRZ1p3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUxMTBjZmFkLWJkNjctNDFlYi05M2FlLWI5ZWFmYTZkYjc2MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MSwiZXhwIjoxNzQ5NTcxNjkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGJmODA3NTItOTA4OC00OGI1LThmYWEtZDAxYzA5ZGE1MTM2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.BLoYhPpb7ctXmNLkS3O-lcuBfeKegoXg54S-bg0NAYqq22PHZg1-5EbztBuazqnoCfZyG4Bu51KbIiB-z0ZEFqqoaU1BOGBstvM8YCQX8pwcasHV5vdF3zus5IarsHkxTup0xc7ZuOisdeQuSfTa9mA65mPrB66DH9g9wEXceobJgUQVBeqwOKxCuogp9Z3Mdr_V5zZRz-UTvUNpgQbiMN0Ro-HBe_lpxySjj9n_2-j9TrOUoq18F3C9-p6T7WCTrHBqKhSsG9hDB2Nedgh3uCQa-OoDpZ5vhWlSJjgq_eoeaIi0P6r-7xIs62UuQv6R_wv3qVYXjINhRs7ARlPaFw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 990
[ {
"id" : "ff848af6-76d0-41db-970e-fd32438acc24",
"identityId" : "9221b1e5-35f5-4726-a3c7-315f132ff44e",
"standardRoleId" : "b5db51fb-cc90-4c0e-a261-a138d239ea37",
"createdBy" : "5a2cdca4-a31e-407f-9aab-7b042341bfa0",
"createdAt" : "2025-06-10T15:08:10.132220Z",
"updatedAt" : "2025-06-10T15:08:10.132220Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 51 Admin - 1ceb2fe4-7dfd-408d-b55d-3a9f4f9cadb8 to identity 9221b1e5-35f5-4726-a3c7-315f132ff44e"
}, {
"id" : "a76890d0-3d0b-458f-b322-e5a6850f6fb7",
"identityId" : "a0273b0f-ef4d-42ac-b62a-8f0876c19e7f",
"standardRoleId" : "2c971693-b9c8-4949-b737-e2e61f22da94",
"createdBy" : "1504f821-9f28-452d-881f-994d188fd453",
"createdAt" : "2025-06-10T15:08:10.990809Z",
"updatedAt" : "2025-06-10T15:08:10.990809Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 4cf5f4c1-7db1-4a4b-8081-964ef1f2cb10 to identity a0273b0f-ef4d-42ac-b62a-8f0876c19e7f"
} ]
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/a0778901-02e1-425b-8a19-31f4298379fd' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJOalotSlU3UTYtakp2WWRMTWxQY2h3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA4M2IzODI3LTVhZjgtNGQ4MS05Y2NlLWE0NTdjNmIyNTc2YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MSwiZXhwIjoxNzQ5NTcxNjkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWI4MDVlNWQtZDRkZi00NDNmLThmZjQtOTA4MDBiZjQwOGYzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.hPIAwrOkFc8BA6Y5ISKFuOj42E6py0SRttxAcbR6M30HDcU0aXKKZ7gh_syouBeI594lVqU1w2BCUHy5ggbW0K1DmeEmkXefEzpyNrm5d4zNOtlL19V77vN1LPgRDY1LDuknRh1tRRWBvZ0MLx60M87S5NgTCRgoDxCP1xYynDfC4lfdu2F4WrZ6TCBg0sOUdPD2_l6FcudbGmoIZ1Tl0GHOrrVPED2CY1YTSyaECGi01bMNxUKqfBx9OGBZHHjq9QaeT_HBRqG5lhQRTGN56MCSuDLEy_uzhGV8RP_r4CptxzBMVgINUHEJMJLFbPfsqvwPRGaBUhmrnLkz1DFipw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "a0778901-02e1-425b-8a19-31f4298379fd",
"identityId" : "135e686e-83ef-4518-9e0c-6d70f466ea17",
"standardRoleId" : "8110b24b-8880-47e5-96ab-7a592f47fc7d",
"createdBy" : "3d10041a-c7e9-49f4-8bb2-d2963c00396e",
"createdAt" : "2025-06-10T15:08:11.209854Z",
"updatedAt" : "2025-06-10T15:08:11.209854Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 63 Admin - ca702281-5889-40fb-b489-352894852913 to identity 135e686e-83ef-4518-9e0c-6d70f466ea17"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiIwZ21idUFIVUdlZUdveGkyaktUVUVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE1MDRmODIxLTlmMjgtNDUyZC04ODFmLTk5NGQxODhmZDQ1MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MCwiZXhwIjoxNzQ5NTcxNjkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzAxNmU1NDctNGJhNy00ZmRmLTgxMjEtNTdmZGJmY2YzMjkyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkwfSx7XCJpZFwiOlwiMjBkMmEzYjItYzJlMC00OGY4LTkxMDEtNDIzNmUxNzI0MjFjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.h4il14y5d5RLyxMODDKRLAVchCoouj4QoBF0WvXSr-cclmVpxDE732bIncrnREOnJYNY-1R42m6gQTUx4WoGv1Hm9N549yPexZILk79aQ-9KPVWZOamfh9gPmhsKNd7AviFftmfFruD865wm41mSsfe5mtDhOUNBKjTdVo51fDmmkLoa2ysD1xoBQySKDgeqQT4D_Ov6IbtnREYC8BLescXdw6kvDIlhltLhzx2tAYSa69ct4Q2HRGZsaDCI8S_-xxLis7LnEbQkmmQXuN_G-L-nH-MvXfGtFzPCk9TMVo1MLSzTmw-enI_sCLDwxaH-c_v7ifkQ6otkGD6CTQEl2g' \
-d '{"standardRoleId":"2c971693-b9c8-4949-b737-e2e61f22da94","identityId":"a0273b0f-ef4d-42ac-b62a-8f0876c19e7f"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "a76890d0-3d0b-458f-b322-e5a6850f6fb7",
"identityId" : "a0273b0f-ef4d-42ac-b62a-8f0876c19e7f",
"standardRoleId" : "2c971693-b9c8-4949-b737-e2e61f22da94",
"createdBy" : "1504f821-9f28-452d-881f-994d188fd453",
"createdAt" : "2025-06-10T15:08:10.990809Z",
"updatedAt" : "2025-06-10T15:08:10.990809Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 4cf5f4c1-7db1-4a4b-8081-964ef1f2cb10 to identity a0273b0f-ef4d-42ac-b62a-8f0876c19e7f"
}
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/2db04b4b-755a-4a02-9fec-7288a9466550' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJ4RjJpSTRJY2dyQjhjME1xdnBUU3ZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI3MjYwMGMxLTEzMzYtNGIxMC05M2IxLTZjNGY2YzY5OTkxYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MSwiZXhwIjoxNzQ5NTcxNjkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjRmN2JkZDAtMGNhMy00YmJiLWI1M2MtNjk0Y2M2MDg5YTUwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.KOLlEBHBq0RLXkEjDMtybIc3yxjI8cVUWUkhVWOKfLIar5ts2xke5g8ThJoSd645WEQxIdhEMnC_qbTdNXoaevYBd-YElJvw3lojOYky6BLFimgrp9C3Q0OzikrTns2oX9zV5r6e-fmBFaslcNOspgpHKP0_vx4Frx6ZSij3wwSJ2X2qmUhxpDU5EKuI0GTpTnNBdhOprvkQMq6i77mLWw9toVSXn16awkUGkAwHgXo8qkLPH5u8VuZZNXdkcL_Jd7e_Mc0-W-HcY08Nmb-NAdCrp6EjwbUf7SWrk0hGrDSrgYi085Q4gLg1xDNkak7g4GXFHPwcHHRY1CUqm7qQGg'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJqdjhfWFlCTGFmSWFodGtpcWM1QTJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJkZjY5YjFiLTI1ZDAtNGNkNi1iZTFmLWI2NTYyZTQxM2M4MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MSwiZXhwIjoxNzQ5NTcxNjkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzg4MDcyMmMtNmI0OS00M2NiLThkZjMtODNmZjY1NjQxYmFjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ObcPFnW8EoO3wmbHufyPdZFUBxr4jl9O6iJj3FH1VIuJ5r5DMGVPBxdQLNhDJ0h549L-wwjKmkDrR6_Tr_mMItXFp3IBhCpkBYlN-udhHaBg_l7GRWFCtzE4JNrpkFRTczAVkhXgn_hKEllbjJZUpMj0KcxrSRXvBWx2pi5oIOAJBVRG8M5X4ckyCm-aQjGqQ8hDC-65AlkJoEMxFl4L7g92sROvVemKVGzetzER89MxRmc3tyVz--aZTu_t6aMoQe2YqYupxsrFWs2YI9TWiJBv0TBrklztCgCwpClpHhFadPg8Rhj2xX5sAQlQR2Mgcjc79CTn773Ku45tV2kiIw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1037
[ {
"id" : "885ff2d6-0ac0-403e-8566-c048fbe1019f",
"resourceTypeId" : "32d6c5fd-605d-4321-968c-1281f379d13a",
"authorizationStrategyName" : "Read-Only",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:35.582835Z",
"updatedAt" : "2025-06-10T15:07:35.582835Z",
"_title" : "Organization Read-Only"
}, {
"id" : "15a4868c-157a-4d03-9ae6-c49da840ba3a",
"resourceTypeId" : "e4b1a9b0-5ed0-430a-a778-be3be6b923df",
"authorizationStrategyName" : "Admin",
"createdBy" : "a5c023dc-11d1-48e1-983b-821b8b5a546a",
"createdAt" : "2025-06-10T15:08:10.078195Z",
"updatedAt" : "2025-06-10T15:08:10.078195Z",
"_title" : "Test Type 51 Admin"
}, {
"id" : "b871c9d5-c1b5-472d-bd04-cb3811e2a1c1",
"resourceTypeId" : "308169a2-b75e-411b-a40d-3d396ba6e771",
"authorizationStrategyName" : "Contributor",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:36.580273Z",
"updatedAt" : "2025-06-10T15:07:36.580273Z",
"_title" : "Network Contributor"
} ]
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/16ac6eb5-b9bb-4099-85d8-c162d65e3b71' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJFQ05pVzN1algzZjlTdlBIX1JWMUtRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNlOTdjOThjLTI0ZmItNGM1NC05ZTdjLWU3YTMzMGY4M2NmNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MSwiZXhwIjoxNzQ5NTcxNjkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjUwYWEwNjMtMTc4NC00Y2IxLTliOGYtNDFlZGE1ZGYyNmVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.LO55HYRsEPCD9v-_Yc57iM1kwd3gqOHvzldIxTzjJgQMvtKKMQ7vbXSknJSETdoKsC9IVXw6LwfqWW_nhcwbTksc9APcBEdCOuUqWihOqPp9ZtxWN6zeTqjsFTnF_Kv4jvFnvezYo3D4VsccQA6ECLb7EF02vWvvw5ujpi8Yy64BRO6hDD8x7pZ4UffYCmQpw-uBiw_dlB8gZLZ631bJTTFPTvrmnS4CIHRZ0yDfAhtEUdDmosPjR5-DOXigdn7ioOsJ1ireYhxDfLJ2bR6FH7qKfof0UAGGqUSIZUr84fCJZrvrAsGJOZ-bDWlN4JN0n2MqqjPtwnPLs9fdbLI1zQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 338
{
"id" : "16ac6eb5-b9bb-4099-85d8-c162d65e3b71",
"resourceTypeId" : "b440c2e1-2b7c-4ab3-9e68-c42e9a87ed84",
"authorizationStrategyName" : "Admin",
"createdBy" : "f6295bb6-7242-4648-a9e7-3cc2aefb1422",
"createdAt" : "2025-06-10T15:08:11.635335Z",
"updatedAt" : "2025-06-10T15:08:11.635335Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJIVnlkV2N1bDRxcDRTS1A4RHpDQkhnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU4Mzk1YTcxLWMyYWUtNDZkMi05NTdkLWU4YThhY2I3NmEzOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA5MSwiZXhwIjoxNzQ5NTcxNjkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcIjgwZDIyMmQxLTJiYTEtNDQ1NC1iYmNmLTVkYWQxYTU4ODg5MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImMyNjllNmYzLWEyNzYtNDRlMC1iNWVmLWM2NzFiZjJiODAzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA4OH0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTk5M2UzOWMtMzE0NS00MzM0LTgwOWMtNjVmNGE2MDgwZTEwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfSx7XCJpZFwiOlwiYjRiZDkyNWEtNTdlZi00NzdhLWExMTgtODA4ZGZhMWMzYTVlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDkxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.It2jjW6QTxdmXw5vjRaGlOQnRcUfRpo2ZMeFZtqF9dkFgPuI5UqfchJWtneyvakFh30fLuclNb1U2FfVUv5BMGABuIL8vTh06pWVSwF6d6UdVmdM0Tt_MOsE4xrEAmAIsQdTJ3EeQk6Z-Ltyk1PJo28ed4qbUeHAggvRySBw_lVE5S0nmddnjWqMCbvfbgrvwiez6e7J4fuBUf2u1LDTlZVcOq8FqSpWywb6MwUceeZE5Fq1_f3lzW-vqmZpmXpd9raNTxnPHxowBCiY0zX0Cf5BpBDwopFvbxV9_RPUC9GBvH7l0hYQPD2MDKXaSzwlQUKu2-vUCdAh3HQPmcsSZQ' \
-d '{"resourceTypeId":"a7b4bee0-5831-477b-b3e7-ea1f7f10f0da","authorizationStrategy":"Admin"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 335
{
"id" : "b173b31a-a930-4917-bd1d-807471c040ec",
"resourceTypeId" : "a7b4bee0-5831-477b-b3e7-ea1f7f10f0da",
"authorizationStrategyName" : "Admin",
"createdBy" : "e8395a71-c2ae-46d2-957d-e8a8acb76a38",
"createdAt" : "2025-06-10T15:08:11.514136Z",
"updatedAt" : "2025-06-10T15:08:11.514136Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJKQVBHNDBMOHFmTjljR0FSd1JON2J3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM2NWZhOWYwLWY2ZmYtNDJiNi1iODEzLTc2M2Y2ZWMxZGFhMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4MiwiZXhwIjoxNzQ5NTcxNjgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmU0MDAwMGMtOGRlMC00NWUxLWE4ZTctY2RmYzJiMTY0M2VmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDgxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.YJy622qfWJ88yacBt7XtfusrY8SBKHBh6aA17WynpRdwBD4B6pvLO1-q-UfpdbtwZDtSyA9NHES3pOcNNgJIWESi2xQePvIEsTQ0XnHzEV-JpwYpI3cbrig0-NBN72ZShBYfg9NhpJpOrNeyBts1XhRqMw1kDX33Rpsb5lAGGw-j1UOq8Q0PELve65iHxXX5KDxcVVA6sf-LSyEosST8WySog_iomo_IepGP4K1Gc6poXjzXabzu86WYq2D37DYG84Qgnzn15bThujcomozVrbrdgD8oXih79AIug6DQ4aKfYa0t6eOpkC9pGKY2zmY0MyAtR-IAJDxYdsB_KAUe_Q'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1578
[ {
"id" : "3cfe40ce-2276-4196-b9b5-2619fdb64412",
"resourceActionId" : "fe382351-1d61-46bf-b0d4-8b0d76dcd00e",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:37.308347Z",
"updatedAt" : "2025-06-10T15:07:37.308347Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Update Edge Router Policy in Admin Standard Roles"
}, {
"id" : "fbebd815-10e8-410b-a342-73095539bdf9",
"resourceActionId" : "5c95bb86-13f6-4948-a6e3-578086dc8367",
"authorizationStrategyName" : "Read-Only",
"includeWhenAbove" : true,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:36.113948Z",
"updatedAt" : "2025-06-10T15:07:36.113948Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Read Action Inclusion in Read-Only Standard Roles"
}, {
"id" : "e938939e-8897-4ee1-854b-f2f1289dbc04",
"resourceActionId" : "debf7523-5ba3-4488-b919-d4129edf4959",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : false,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-06-10T15:07:40.107927Z",
"updatedAt" : "2025-06-10T15:07:40.107927Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Delete Attribute Mapping Config in Admin 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/c6aede4f-9f4b-4c4c-bf41-8dd6b83f3dd1' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJyN2xHbnpLdHFfUWJoSl9lMVZUSTBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImExZmNkNDQ3LWFhZTctNDdkMC1hYmQyLWQ4M2Y5NTJkYmQ2NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4MywiZXhwIjoxNzQ5NTcxNjgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOWUzNDI2YmYtYWM0Ny00ODliLThjMTEtNGIzYjg2NDVkYTE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.h85jF-I-diC6ebq2Ewh-4xrmNGxYHF_X_qBzZOUmgW5D1lOQ3hsM71fFd1zfNcz7JBZCC4wq3WldIUpYgmZtVoKkJbkvtv7n1QJTIheV85ZXbdH7IjTZwVz_hbLvQyjEedVKjka5u-ixCAfwVobahUsLFj1Of4PRsYMjIhbXpJLrwjjodgEJvENN0X3b4HvLHNYnsqD20hq-bwKQgiK0PQlLzW8QT2Kju-fikKe0ObxdkdM8kgln_8vpNCJ0Oov2uYpOw5f2ZBniAoV_47AX4R0t6MOoshDekCXUw5NCSaMDiYYdsutNjeeZq8ZPbS94G7TzUxA7qLxsJWjckK7_HQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "c6aede4f-9f4b-4c4c-bf41-8dd6b83f3dd1",
"resourceActionId" : "3ba03cd6-13de-44cc-b419-4f56dd81b59e",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "e85cb7f5-915d-4794-8906-bb2576f046cd",
"createdAt" : "2025-06-10T15:08:03.282396Z",
"updatedAt" : "2025-06-10T15:08:03.282396Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJSWmllZUtTeDZfcDl4MURMallpR2Z3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRhM2QwYmU2LTAzMGEtNDFiMy1iZmFlLWRkMzU1ZDU0YmY3ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4MywiZXhwIjoxNzQ5NTcxNjgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTZmNjdlYjItNTM1NC00Y2I3LTk0ZjctY2ZmMTMzNjdiOTRhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDgzfSx7XCJpZFwiOlwiYTNlNDRmYTItMmM3MS00MWQ2LWI0YTYtNTczODVhMTdkMGFjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Vyky0YOpMKND3RmPHzGNnvODOSAzZDnW2sQcsvKhuaGePvvJPKF5q3NxiCVK38s2L3OJFbrg1A3qXZx9jFbY4hEqhkkdwMyJcNLXCbq4r914PCoaE9Eo-4xCjxCFUXqYW3sSjba_Ob_Ops4PTewryKAHyMlxZuxUDsjdrhdF5DFXlje93eXv6UBCEJZxMehdVfAsgzklDtuZ-RV7cXTyfcQ8Wn20JYNMol3RtiR6_-VequSzJBWd8te9de3jKQB5Wd9VlhchV5y2npQMIvUOMLb-uqMjoPeR2fLXVxm65SjM2cqZVTpQ5JA9bZyle_s--QX0HYw0fXgKP7k4l1hWoQ' \
-d '{"resourceActionId":"1798f25e-db6c-44b8-8b56-feb9e8e3f7ca","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 526
[ {
"id" : "8444060c-2022-4278-9ae8-1ee4b784fdf3",
"resourceActionId" : "1798f25e-db6c-44b8-8b56-feb9e8e3f7ca",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "4a3d0be6-030a-41b3-bfae-dd355d54bf7d",
"createdAt" : "2025-06-10T15:08:03.960331Z",
"updatedAt" : "2025-06-10T15:08:03.960331Z",
"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/26916f7c-b339-4035-8db6-7039f7e9cfc1' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjAxMmI3N2U0LTUyZDUtNGRhZS05M2MzLWQyZjdiMGY3NWQ4YiJ9.eyJqdGkiOiJhX3ZUdktPQkl4cGpOX0ZxR1h0bWhnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM2MDM5N2M4LWMyZWMtNDI5ZS1hYzA0LTllMmI5OTAyNGY4NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0OTU2ODA4MywiZXhwIjoxNzQ5NTcxNjgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjYyMTljZjYwLTBjZjAtNGJkOS1iMTFiLWI1ZjhmMTE2NGQ2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI0ODBlNDUxLTRkYTEtNGFhNi04MWY3LWQ4MjdiNWU4ODgxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcImI5NGExYjEzLWM5YzktNGZmNS04OTlhLTY3ZmFlYzIxOTVhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA3Mn0se1wiaWRcIjpcImRiMGU0ZWQzLTM1NGQtNGI3ZC05YThlLTMwMGFmYWM3NTYzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjc3NjQ4OGZiLWJmYmYtNDYxMS1hYzYzLTQzMDhhMTcxZTA1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjVhODk3NmViLWIxMTYtNGQ2Zi1hODFmLTkwNTI4OThlOGNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1Nn0se1wiaWRcIjpcIjhhMzE0YzYxLTIyZjUtNGEwNS1iOTRkLTc5MDc0MjU1OTA0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImU4ZWEzMjhhLTBlZDEtNDFiNi04OTA0LTZmNWM1ZjA5MGM4NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1N30se1wiaWRcIjpcIjJhMWQ2OGNhLTQyZTAtNDBlMS05ODk0LTM0Zjk2MDJmNWU1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1NX0se1wiaWRcIjpcImEyNWRmNGYwLTUwZGYtNDJiYi05ZjI1LTg5MjY2M2I0MzAwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0OTU2ODA1OH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmQ3YmMzMzUtNGU2OS00ZjBkLWI1YzMtM2E5Y2MxYjAzNWRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ5NTY4MDgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.m9JhjzjcOq86tpxzx-XH3YBOXy6Ul-uToyYR4zUm2qs9Bw9S461aHiObr2ooIB5vdL_ZdCv2x9fdF9JvHR7Zc-RZpDtzoBm3SdO0hWKm1mRFg6VOpqtf1UDb8EkpNn5ena13gF93P0WZSZmK55JSSWViJQ-1X2VrIoFCNFDaVAEolK3KwLKiERoSGTzyhtoNOnCDyYE_lqEt2IvfIpn-j9ePCnHNHJY9XamaKUycVh37-LlgxiIRJLNATKZiP1XMLQaZckEgXYFTbVoRYopzfhtTcxbhFPWHL5574IhLLFj3RBKyNJC32SYIqBbyG6BLdD1Ws5BxMYbUeD5vsZpFXg'
Example response
HTTP/1.1 200 OK