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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJURlBydVZyeGVBTEVNODFRU2cxVkFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUyY2VhZThmLWFkNjktNGJlMi04Njk5LTM1NGQ5MzE3Yjc2MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMSwiZXhwIjoxNzUxOTk4NTIxLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjRiZGUwNGIxLTM4YWUtNGYyOS1iMjI1LTVmNWRjZDI0YTc3ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyMX1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMjE5ZmY4YzQtMjg1ZS00NGViLWE0OTItNGMzYmVkMzQ4NzU1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMjZkNDNhMTUtODU1YS00MWM2LWExM2ItNTc1ZTcwYjY3NjQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMmQ4M2RkNDQtNjRkNS00MWU0LWEwMGMtYTgzZTgxZTI5YTk2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMzE0YTdlMWMtMzZjOS00ZjI0LTk5NWUtNDFkZTFlMjkzYzExXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTA1fSx7XCJpZFwiOlwiOTJjNTk0NmItYmIwMy00OWUyLTliMGUtYWU5N2E3YjVjYTA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkxfSx7XCJpZFwiOlwiNmU2NDM5YzEtM2U1Zi00ZWY3LThlMzEtOGEwOWYzMjMyZjE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkxfSx7XCJpZFwiOlwiYWY1MDZjYTUtYzhlYy00YzdiLWE1ZTQtZjRmZWY4MTNmZjc3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkyfSx7XCJpZFwiOlwiODVmYWRiMmItOGZjZC00NDM3LWI1M2YtZGYyNDUyNmYxZTc0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMTcyYmE0ZDAtMmEyYS00YTlkLTg4NzgtYTRjZTdjMzNkNjE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiYTIzOWQ3ZjItOWQ5YS00ZGI0LWIzYjMtYWRjOGE5OGFiNjg1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.UxRUk8SEMYBKUmZyHoqYgubzOw5PHwKZj3zsHkDIGl6JzU_dJNL56jI0tl2vOTEJSqmyvlvFvLIH9IIzo2zPoEgN_yVNSbMh8jV7INUBH4GrsHF5ZpMaHnQCR5owXNmWstFF6FscF5zWfCC7TAtEn5FIclFFUBLGT-zEiIp4OLMxO0T18cF1rkYwNrQlEhTAGj7a6NNHxJa216NdRgY09mi4vcEknLTJ5phU0qAKsvtj_zb2BljwJAZnGN83XfpkB41NPWOwRn79RCzCgnCOpKonUXZrMRdRz8N0V3g77l1Kcw60eGYN-GSFamZM1fYsf64cDw3oqwLyRmwF-GE3vw' \
-d '{"identityId":"1f2912bb-74df-4112-b2cd-4dbe241d27ed","audience":"io.netfoundry.test","claims":{}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1950
{
"token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJxam5IZVNSSEsyUGhZdS1TSHd4STB3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFmMjkxMmJiLTc0ZGYtNDExMi1iMmNkLTRkYmUyNDFkMjdlZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTc1MTk5NDkyMSwiZXhwIjoxNzUxOTk1MjIxLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjJiNTdkYWUzLTdiM2UtNDBmMi04NThhLThmZTU0NWY4ZDM2MlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMjE5ZmY4YzQtMjg1ZS00NGViLWE0OTItNGMzYmVkMzQ4NzU1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMjZkNDNhMTUtODU1YS00MWM2LWExM2ItNTc1ZTcwYjY3NjQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMmQ4M2RkNDQtNjRkNS00MWU0LWEwMGMtYTgzZTgxZTI5YTk2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMzE0YTdlMWMtMzZjOS00ZjI0LTk5NWUtNDFkZTFlMjkzYzExXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTA1fSx7XCJpZFwiOlwiOTJjNTk0NmItYmIwMy00OWUyLTliMGUtYWU5N2E3YjVjYTA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkxfSx7XCJpZFwiOlwiNmU2NDM5YzEtM2U1Zi00ZWY3LThlMzEtOGEwOWYzMjMyZjE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkxfSx7XCJpZFwiOlwiYWY1MDZjYTUtYzhlYy00YzdiLWE1ZTQtZjRmZWY4MTNmZjc3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkyfSx7XCJpZFwiOlwiODVmYWRiMmItOGZjZC00NDM3LWI1M2YtZGYyNDUyNmYxZTc0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMTcyYmE0ZDAtMmEyYS00YTlkLTg4NzgtYTRjZTdjMzNkNjE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiYTIzOWQ3ZjItOWQ5YS00ZGI0LWIzYjMtYWRjOGE5OGFiNjg1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.JHQHC8YsVQNdSxmBHsBvyMbS2VVYMG4_oaQwm0-sDR_c1AE6-fSJ8rQaw-1toNPYa-J8bCHfI-cCrk0IZMfCaCwomJ7a29W8p-0HGrOqUbwK7gp8tO9AQFCYJIlO5eBDVXxQwYQDalynPpcgjqVp7Hee8fwlC9h-BM1VTveCvj8NXOjMbj-UAwKHuEFmfxSlorevtZPb353el3hjvtdsXmme-S1-4Kg7qy95JsPbI8jPIJbIRtA-7jlrkeJwoHDHwzGPeI6SJvtvs3y8-qf9o7I-2kBgHYOQPNnUb9z9Rc6UYTmXUH_yS69ZWisKt7fVRRgPB-4Y1jnT_yVGan3EiA"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJmdnJRbUl5Q0s1amZtMjVBR2FZLUx3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMwOWM0OThmLWFhZjMtNDNhMi1iZDllLWQyNmJkYWUxN2NmZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNCwiZXhwIjoxNzUxOTk4NTI0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzhjODA5ZmQtZDgyZS00NDFhLTkzNDQtY2E3ZmFmMzBjYjU2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.P7hwB8KyKRCttf0bnyerRLgCXkc5QTOjXvXGENyY_cdOzbWjcYJ49_vj0iJXcuftUbH6faOjSLyoQuSy_sVQoNqaq1odddn_OzNJgJUelTLy4b_pH_59vuQxCohd6ugQxRryPiDFZ46IqQFlGu0rnsI1nSoJy0pQB8poeZNrTLOHJunNrFXvFvy4kjMOkiwBIfGwAyTLtufiMaIzCB1rSGdJWjXlchOUv9IYgnzMj1xgdpfIw-aeUk-fRvPj9xKMtuGkr2TH4ZrBzIaVoLECIgTODGk7Syv1lsGLmN9GxRkzzFJEfzmuILhAFq3UxweZjRyCaz52KYAJ01hO1lg0EQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 866
[ {
"id" : "b67a42c9-85a0-40a5-b8cf-81bcf902340c",
"name" : "Billing",
"code" : "io.netfoundry.billing",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:52.936598Z",
"updatedAt" : "2025-07-08T17:14:52.936598Z",
"_title" : "Billing"
}, {
"id" : "1f4dccae-54e1-4f84-84b8-44248a655750",
"name" : "Test Domain 24",
"code" : "test.domain.24",
"createdBy" : "30697d95-0711-4531-af74-aa87f2a192a6",
"createdAt" : "2025-07-08T17:15:22.313609Z",
"updatedAt" : "2025-07-08T17:15:22.313609Z",
"_title" : "Test Domain 24"
}, {
"id" : "522aa467-734d-4bce-849b-8680299ac7f7",
"name" : "Networks",
"code" : "io.netfoundry.network",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:49.680106Z",
"updatedAt" : "2025-07-08T17:14:49.680106Z",
"_title" : "Networks"
} ]
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/4871c4c5-dee4-4a84-8e42-b34482b14e92' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJYTEFOcl9zQm9lYl9qMW1lRXFZY3FnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJkNDMzOWZlLWUyY2QtNGEyYS1hNDAxLWM2YzM4NDA2NDE0MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNSwiZXhwIjoxNzUxOTk4NTI1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWVmMGZlOTQtNjhkOS00YjA3LTg5MDUtZDY4ZWNiZWM0MTJhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Th9CPiLmxnWdsOnz8MDFAoN9cHxGr8FBVm7p16yU2avbVRWcXEOTTgJiPjWso9D3FMcGKeGf6qE6NAFgJAwHnjm4vv6Fe5ODKmqu64z22cx437x3NbmZat8gM58Jm1ZxcLfSzy34revZLCvp9OOriLvTN6Umm_9hr1Bw5E8f2qIA7lF6yO94Ci-R-KuHLis_zq8xHalPl59CjKtm-AHU3w7POUzW77FL_PVAoCrdujM7zfQHA3HQpBrf_GVOtYIGp2kwqAExOypk22mk-h52ThQf-5X9VnpbuTbIhv9hQMHBLkjXerecMMvh3pj67e4WYI0karUBkIv7x2QZ8uR3kw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 288
{
"id" : "4871c4c5-dee4-4a84-8e42-b34482b14e92",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "204af36c-82e3-495d-a142-8af117c21164",
"createdAt" : "2025-07-08T17:15:05.653575Z",
"updatedAt" : "2025-07-08T17:15:05.653575Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJpV1MyNk8yYXVIZFdVa1VzNTU2blJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNmODViYmQ5LWNlODUtNDUyNy1iNTliLTMzYmNiZGZhMjgzZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNSwiZXhwIjoxNzUxOTk4NTI1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjJkNjVmODYtYmFmMS00ZDU4LWIxZWUtY2YzNjE1OTM0OTU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Lcvq77f6IAuKwVEuSJGYVNaWxKWbs7ZlWr3JvoO_XDXHKu37tbS8UXAa2rQKGMhYt3pQIuJ7W-1Xx-aW_qoHJ9-9cKHGUE4IYKVDo5Eo1qk5WwMCnAsvz173MgNwH-U5emkR-zNG36sKxOtcjSx_EsGvEPY-cYUhn-iSDCWT1bAHSvqvgXN3-Fadt07NbsWWFVYHXs15B4Nay0o3YtCXmxxUiUCX8vsZy-1Gcd3Usxv3AfQswMIqNBX1-Z55xLqjCznm9K2IMsoQ2wGZTvSwySC0D27kvwie26c8BsRheC1mXz_bv6PpnrAkg4gFfnO4AQ-p9kMX0TPYMd0WKs10TQ'
Example response
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 288
{
"id" : "4871c4c5-dee4-4a84-8e42-b34482b14e92",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "204af36c-82e3-495d-a142-8af117c21164",
"createdAt" : "2025-07-08T17:15:05.653575Z",
"updatedAt" : "2025-07-08T17:15:05.653575Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJjZG9CMXZ3djhVNUlRSHhVREJXbDFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY1NzI1NmJiLTVmMDMtNGJmMC05NWRjLWVkYzA4ZjY3YjkxMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNSwiZXhwIjoxNzUxOTk4NTI1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTQwYmE3MmMtYTAwZS00MjE0LWEyNDAtN2I0NDYzMTU3MTQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.bAwhOhpJgj-yh9r9lQ5DcI8xK9phcI6gqhAsYlRG4WVpd46Xf0JTfqLA3LAOysCKXZOyLxHBGvKORkopH2U5_-8EFq4x4mKpByEur1owANq0xeXu4ZYByONI_Zdusb3VycFmWZldXgJHD4mebR-7q0erS3XrGAmP1L9zY61HNNq3cht4qoKCM3ssJk-PxhPb1P3Y3l-9CWTgi_opjErGTgYGB6sG57WczErcKLvJ2OLAZRnitJw1vmrdnhNvjSPLUrauXnNpP1kkzL8BfCNujyVvqTfEAhxKEygdcxbpI7HjHAcNSmDbykTqBgwO44msBX9JOezEdv4gIKvvd1TjQg' \
-d '{"name":"Other Test Domain","code":"other.test.domain"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 299
{
"id" : "b44e7e0e-9aab-4737-a96b-707750ea783d",
"name" : "Other Test Domain",
"code" : "other.test.domain",
"createdBy" : "f57256bb-5f03-4bf0-95dc-edc08f67b911",
"createdAt" : "2025-07-08T17:15:25.347013Z",
"updatedAt" : "2025-07-08T17:15:25.347013Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJlc2xLanl2aFp0N1FnSFFzVDdhcUt3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdkODU2ZWVlLWFjN2MtNDNhNy1iMGFkLTIwODhlMzY1OGIxZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNywiZXhwIjoxNzUxOTk4NTI3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2Q2Y2IxZjYtYzhhYy00OWVmLWI3YjctYmE5OGFkYjJkOTEzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Xi4i_eDozEZzf1Jhvv5gB_F-s-11SOw2giIbqDDSaPnX6o0DHD1xBmbYe9RzXv-W_8oxeLz-jzb2vONXxSzSsNnfdCGkT3mgB1zjPevEkv0mLoNJeFBkNoIPSzCNzfQCXPj6pCvOwN6dX7uSlOXscpqiqAwn4RP_qdAnr7VD9POYqmDR5LpGQi6jXcI_xn1nmAvvKODuoIAzY4GW3Q3WoFcL0F1-48ItiARk9wSk6D9BFcNAXX6_zi6eJDwE-H3f4IZJ5dBZkOfYbQQWcjM0LoluxBr2vLykIVAsi58NMf8ECew1Be8uuRCfZ5RZlPPoVW4CPGFaaFjcagU9nPXYjg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1285
[ {
"id" : "934005a7-7aa4-4eed-aec5-f4d6b2feeb41",
"domainId" : "f439983a-790a-42be-b024-c68dfe1650a9",
"name" : "Test Type 6",
"code" : "Test-Type-6",
"createdBy" : "4b99f7cb-9018-4a6b-9858-4b8628fb615d",
"createdAt" : "2025-07-08T17:15:10.870340Z",
"updatedAt" : "2025-07-08T17:15:10.870340Z",
"parentId" : null,
"root" : true,
"depth" : 0,
"childrenIds" : [ ],
"_title" : "Test Type 6"
}, {
"id" : "e934c8e3-1e89-41dd-9110-5a9d15b1229c",
"domainId" : "a5e9c7b1-3a74-49b6-aabf-c61a2b628a46",
"name" : "Signup",
"code" : "signup",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:53.255756Z",
"updatedAt" : "2025-07-08T17:14:53.255756Z",
"parentId" : null,
"root" : true,
"depth" : 0,
"childrenIds" : [ ],
"_title" : "Signup"
}, {
"id" : "fec74cd7-a403-4652-9f10-638afc2d84bc",
"domainId" : "61db9427-2e71-48cf-ba00-e197f085efbc",
"name" : "Custom Role Action",
"code" : "custom-role-action",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:50.616859Z",
"updatedAt" : "2025-07-08T17:14:50.616859Z",
"parentId" : "28911c43-e3d1-4932-ad93-3d0e6f91614c",
"root" : false,
"depth" : 1,
"childrenIds" : [ ],
"_title" : "Custom Role Action"
} ]
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/8fe3be68-03fb-40aa-8bfb-857617b5288f' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJmamRWbDUyX2xUVEdzbmJCTGgzYnlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY4ODg4ZmQ1LTJmYTUtNGNiMC1hMWQ5LWUwYmEzMWJjNzViYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNywiZXhwIjoxNzUxOTk4NTI3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzkzZjJlYmEtNjIxNS00MjBlLTlkM2EtYzYwMDQ2YWM1OWEwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.phGa2XHvmNuXz95qmJBe-umHygBDD8ushyKrlu5FtHY2X6VubDiI1YJfKd9-Q80mYUMNLBCw-W-QidiSD3v7d-JUMFxtxyr1XLtPBzmXLiIxcuTkthNkKJECws02pao0Hx21-e6jCqiDyvBE0e1HES8PCOEjY408HSj96mCrNNyWwza_PKkZTEFhU_ka2FikZ_mdKiEmDmygky62bfMyt6tTTfeznNmX4kvqSaY4bLxSkq_8YIDIocUv4uTLJmG4300-_3p6nNDzTxvqLrbFjj5nNRdijb1l5smuHQ68WbTpaomE7MJtMwPCQoHaFFAeYUItvmGRl7Q6B-Vl-qT0Tg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 406
{
"id" : "8fe3be68-03fb-40aa-8bfb-857617b5288f",
"domainId" : "4871c4c5-dee4-4a84-8e42-b34482b14e92",
"name" : "Test Type",
"code" : "test-type",
"createdBy" : "283a5a80-08cf-41cf-944c-b01ea0f83c18",
"createdAt" : "2025-07-08T17:15:05.786276Z",
"updatedAt" : "2025-07-08T17:15:05.786276Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJ3cTFNMUlkSmFMZmpGbUl6YWdwbG53IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAwNGQ0ZmY3LTM2ZTktNDQ0Yi04ZDhiLTc1ODg2OWM3MmJkNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNywiZXhwIjoxNzUxOTk4NTI3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWJkOWE4ZTktNDZiZS00ZTU0LWFiZjAtNjg4MjcyNDIzNDc5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fSx7XCJpZFwiOlwiMTQwMWE3YzktZTliYS00MjA3LTljNGUtOGFmOWIxZjExYzk3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fSx7XCJpZFwiOlwiMmM3NjYzNTAtNmE5Yi00NWFmLThiNTEtZmQyMzUzZTY2ZjNiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.B45rAF9y9iXyyU4YRs_iLqrKieYQblWQWEeNNq1kh2xO3F9uxEJhYnq8DVp2IlzDas5nAqkOKkFLE-QthcxwVqoeWPfj_J1nw6UBsDy9aehQn5oXu2CbFVTJ_QRYZpt4niKXqUzVybJ-J9wTRQ94NSpGm2OliQ8T9wzeh8QVlxUEkUK1-DtqpUrweUXIsF3kB0wBM2nZ_E3LF4qGtmYiCEXdGV2h-jN2JpH2_GcnpjuEm-pvQi04_8_A7y0yPDfxnLp_GwBJrs5NQfjQm0ruibOYW7LqV23OkQWzOaLBnqHUTKOhiuxVnnBX6nLNh7VlnOEtitQBWzYDxuOxZK-2GQ' \
-d '{"domainId":"4871c4c5-dee4-4a84-8e42-b34482b14e92","parentId":"8fe3be68-03fb-40aa-8bfb-857617b5288f","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" : "71163507-e6df-4512-a151-d7c935fc5392",
"domainId" : "4871c4c5-dee4-4a84-8e42-b34482b14e92",
"name" : "Another Test Type",
"code" : "anoter-test-type",
"createdBy" : "004d4ff7-36e9-444b-8d8b-758869c72bd6",
"createdAt" : "2025-07-08T17:15:28.064890Z",
"updatedAt" : "2025-07-08T17:15:28.064890Z",
"parentId" : "8fe3be68-03fb-40aa-8bfb-857617b5288f",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJQdmhlc3d5dU5lS2hlQURtR0hWb013IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlNjlmZjY5LThmNDctNDU5Ny1iYmM5LWM4NmJhMWMzZjg3YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNywiZXhwIjoxNzUxOTk4NTI3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWIyZjRiZTQtNjkwMi00Mjc1LWI3OGYtYmY2OWU5ODMwYTJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.OgaSujEtgQ3iH6I-7lDf8h3qZIl17x2wSqdRcBCfxbZaanGgZ1tQvLyQRlWsPD72bjPZwS2E_WEEreOHzlZl6LgM6_3_CmQALdPw6GuzVfSDu_QJMUkiAgwqM_pgsiauhMBiR4drIIO-XmaG1z-JEYUpfBFPa5oINOa0zBGXEc0uv9VUrv5ibg17_1f2uOGKJQdeC5kXBmd12HwPQWXRo2tJe3HFalrJGgBloXhtZQFft5T7cQZQckpFYeP4srCJ7ssRhQW9alUAURpZLb5cM3sp1crHJhWQZUzHzX48yef1nfaji10ku3NE2X1xlrEL1r3bdkHhF-QaiUDzhM7CFQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1128
[ {
"id" : "d102d336-9fa8-489b-920b-7fc9600a033a",
"resourceTypeId" : "bc8276d3-a4d7-4cf2-93e8-3e11ff4756b9",
"name" : "Test Action 49",
"code" : "Test-Action-49",
"createdBy" : "a94538ab-9a3f-4061-8fc9-5cf2a0a12f46",
"createdAt" : "2025-07-08T17:15:26.777212Z",
"updatedAt" : "2025-07-08T17:15:26.777212Z",
"standardAction" : false,
"_title" : "Test Action 49 Test Type 48"
}, {
"id" : "c506f138-dd0c-48ce-9173-73a9e562eca0",
"resourceTypeId" : "c76df505-e5ee-48b7-b534-69451286aeef",
"name" : "Create",
"code" : "create",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:51.284949Z",
"updatedAt" : "2025-07-08T17:14:51.284949Z",
"standardAction" : true,
"_title" : "Create Edge Router"
}, {
"id" : "3b229521-caee-4509-9d8f-506b2530cef0",
"resourceTypeId" : "793a097f-ab43-450f-8c2e-b76e965bde6d",
"name" : "Read",
"code" : "read",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:49.714253Z",
"updatedAt" : "2025-07-08T17:14:49.714253Z",
"standardAction" : true,
"_title" : "Read Network Group"
} ]
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/a8e1801d-a04c-4bc4-a2f2-768d55d1d2a9' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJtbWJQV3pqQnJ0QV9Ya0xuQjM3SHN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYxYzU0YzY2LTQ1NTktNDlhZS1hMmM1LTk4YjU0YjI3Mzg0OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNywiZXhwIjoxNzUxOTk4NTI3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzczYmMyZmItOTljZS00Y2NlLWI4MDgtODFhZGFjNmY0NGY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.qT8b_U3tlYOpp4P7ALPx2hp1BuNUMtqPqeXxK9YUfgSSPysrUOyX2aO1PwtjN-1fQ1qfumtDMSFvuyWwgLcho9U1EnQBx5q7qjOp-JQ9jmN2xDYy9uwdHVtHCsYxICcRDC81lmogvtMOB1dXcI_UkCIF6Y-8e5KiLlJ5uGTEPYqYNYQVsOeQFNLzWfmfBY_xF-fyWRdjTr0gF6MV7LtKoRBRhkh7U10kgkAwqnBHkH743LVi3NH2a1XoSCZWBEK0pGawmr_SxN67-UyefBnm4JIbkg8yrFgMQRKt1PxAt2VLt-eVNWlRqhdg3MMY0eGXQfEwv_fkx0etmbDDyACmlQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "a8e1801d-a04c-4bc4-a2f2-768d55d1d2a9",
"resourceTypeId" : "8fe3be68-03fb-40aa-8bfb-857617b5288f",
"name" : "Test Action",
"code" : "test-action",
"createdBy" : "36100f70-b3c1-43ca-b813-5d72ce20b08c",
"createdAt" : "2025-07-08T17:15:05.845134Z",
"updatedAt" : "2025-07-08T17:15:05.845134Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJsdkUwRTRSUm5RcXR2OXFvRXVaeGN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg5Mjc3ZDdjLWFmNjUtNGQzZC04ZTk5LTY5ZmJjOTg4N2JmMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNywiZXhwIjoxNzUxOTk4NTI3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzlmY2Y1YmYtYTRmNS00NTNjLWFmYjktODAyNDg2NTMwNDY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fSx7XCJpZFwiOlwiYmMxZmYyZTYtNGRmZC00ZWExLThjMWQtYTlkZDA1YmUyZGIwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.F3vGCacVm0tsAXTGljy7Trc47ENU5U8HiWpPeHy8R73pA8ijrnQoLAxfOaKLbBh_zFA4xRT5U4qocWSvBWw443lpfzshzx4sCaE9aUrWMZjU8NcXB6QgfG7KYHqLamrO4I_tgdLDhXasmJ0a8sHXvQLsfICbpyr5TQALNtqgjJwJHGrlP9fYnxJ8_unG4G_BGKePiePBVUZ5QglqVii5VoJ-R77gKy-9HegiFi1kQ5ewPc0YvleZEDg4o_TCg0KJjr_RTQJmP8Dk9Pmm2Xum59Ul_5HgRxeVRdCOlcJfZUPZFue7IwEqJmAGUl1idf1GWxupwHVMYc8TLVhaMQEupw' \
-d '{"resourceTypeId":"8fe3be68-03fb-40aa-8bfb-857617b5288f","actions":[{"name":"Update Custom","code":"update-custom"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390
[ {
"id" : "a529f1dd-e8f3-4b51-8102-ce585859030e",
"resourceTypeId" : "8fe3be68-03fb-40aa-8bfb-857617b5288f",
"name" : "Update Custom",
"code" : "update-custom",
"createdBy" : "89277d7c-af65-4d3d-8e99-69fbc9887bf2",
"createdAt" : "2025-07-08T17:15:27.222873Z",
"updatedAt" : "2025-07-08T17:15:27.222873Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJIM0RHTWQ3RkZjS0JJclFkQ2JRMFJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJmMDIzNGQzLWRkZDktNGRhNS1hNGYyLWExODAyMWRjMzIzMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNSwiZXhwIjoxNzUxOTk4NTI1LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImJhZjE2MDE4LTRjZWUtNGExZi04MzgyLTMxZDUxZTBmMmFhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNX1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMjE5ZmY4YzQtMjg1ZS00NGViLWE0OTItNGMzYmVkMzQ4NzU1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMjZkNDNhMTUtODU1YS00MWM2LWExM2ItNTc1ZTcwYjY3NjQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMmQ4M2RkNDQtNjRkNS00MWU0LWEwMGMtYTgzZTgxZTI5YTk2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMzE0YTdlMWMtMzZjOS00ZjI0LTk5NWUtNDFkZTFlMjkzYzExXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTA1fSx7XCJpZFwiOlwiOTJjNTk0NmItYmIwMy00OWUyLTliMGUtYWU5N2E3YjVjYTA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkxfSx7XCJpZFwiOlwiNmU2NDM5YzEtM2U1Zi00ZWY3LThlMzEtOGEwOWYzMjMyZjE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkxfSx7XCJpZFwiOlwiYWY1MDZjYTUtYzhlYy00YzdiLWE1ZTQtZjRmZWY4MTNmZjc3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkyfSx7XCJpZFwiOlwiODVmYWRiMmItOGZjZC00NDM3LWI1M2YtZGYyNDUyNmYxZTc0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiMTcyYmE0ZDAtMmEyYS00YTlkLTg4NzgtYTRjZTdjMzNkNjE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkwfSx7XCJpZFwiOlwiYTIzOWQ3ZjItOWQ5YS00ZGI0LWIzYjMtYWRjOGE5OGFiNjg1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0ODkzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IddSYBHKiqZEDFqWslt6piwFzmcXD-srcgvpAIpzVbWZpBnOXfMZ7xBCL0fweRZnkpO20KntQYpc78zpk9jhA_VNAoV_5Fd7-01PSB2BPGXGrODtEdm91roCstUQwPZDmzBOfLp6lEkdiXEI-qVKjsDNIRRKUachGn8M-JLNIFdBBkqOu7aeAtcHn07SGEf6FWUa2gCSHBdy3rhZlQ3orCkza5f4CEBSNrsUrluVZxUkY9lr1yqY66snh77CCfq8Tp0LLnw-pmOTBannIUXxOpZDN8262FyZA4158C9SulRub7uq-mbDY1U1_QW7fowzQ9WyxhqLyPlw7Xf2ZeimjA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1787
[ {
"grantType" : "IdentityResourceAction",
"grantId" : "733483fd-5ba0-4083-a14f-a625f6f820e2",
"privilegeSourceId" : "733483fd-5ba0-4083-a14f-a625f6f820e2",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"privileges" : {
"io.netfoundry.identity" : {
"organization" : {
"update" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:51.755706Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Update Organization, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "e1816fb5-25db-4d62-8a59-e6ff479803d1",
"privilegeSourceId" : "e1816fb5-25db-4d62-8a59-e6ff479803d1",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"privileges" : {
"io.netfoundry.network" : {
"network" : {
"update-resume" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:53.485657Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Update Resume Network, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "930fd6e5-a690-48bc-9846-5ef8958c0298",
"privilegeSourceId" : "930fd6e5-a690-48bc-9846-5ef8958c0298",
"identityId" : "48ef8928-4f59-4428-b4df-83cd7ec770bf",
"privileges" : {
"io.netfoundry.billing" : {
"self-service-subscription" : {
"read" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:53.161747Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read Self-Service Subscription, All to identity 48ef8928-4f59-4428-b4df-83cd7ec770bf"
} ]
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJCcy1DUGc0dXY5d01yam55OXUxcnNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgxZWNiNTJmLTcyM2UtNDIwMS1hOWEwLTRlMDRiNjZhYTBlYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkzMCwiZXhwIjoxNzUxOTk4NTMwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2ExZGY5YjQtOWMzYy00YzQwLWIxOWMtMDk4NDcxM2I4NWE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTMwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.OuLtpUHtsT8AVF2r27ZNgxBar6qZHhEkQajrji79x0x5JvUku7Sg4iIFzW9-BrCtoGaq39ERPjXdlnJWu-_aOSxxg-WSdDS3T9Mgm3uPOziHsu7vBEpKkyQiXnUjsrq2NJ3gDgOrD9InsZkHsCazIp2aV375hC0yHx4I3GCQXgeHJLONV7Y5ouNGUIHPjqt_Hx-_-lRCPNu3745uJkls7mHX9etpIcH1117WWWkI-sNOkB26h-xrjkmy9AHXYlqHF3uuyImA2upkxsN4ASdFFV7w-7jrGaBsTU2WjwV_ziGQh47FCFIY-mTBniU7z7czWN12U-les63kde3vEqsqTA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1472
[ {
"id" : "4bdb1313-7ca6-417c-8b0f-2ca3d561ae91",
"identityId" : "1f2912bb-74df-4112-b2cd-4dbe241d27ed",
"domainId" : null,
"createdBy" : "d56a2472-b3f1-4542-87a3-377ac1c2893e",
"createdAt" : "2025-07-08T17:15:30.489403Z",
"updatedAt" : "2025-07-08T17:15:30.489403Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 1f2912bb-74df-4112-b2cd-4dbe241d27ed"
}, {
"id" : "4bde04b1-38ae-4f29-b225-5f5dcd24a77e",
"identityId" : "52ceae8f-ad69-4be2-8699-354d9317b762",
"domainId" : null,
"createdBy" : "3cf88974-5c6e-4eb6-b60e-f7fddec14e81",
"createdAt" : "2025-07-08T17:15:21.741094Z",
"updatedAt" : "2025-07-08T17:15:21.741094Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 52ceae8f-ad69-4be2-8699-354d9317b762"
}, {
"id" : "baf16018-4cee-4a1f-8382-31d51e0f2aa1",
"identityId" : "bf0234d3-ddd9-4da5-a4f2-a18021dc3233",
"domainId" : null,
"createdBy" : "1830cdfc-8f08-4d63-afb7-d85258b157ef",
"createdAt" : "2025-07-08T17:15:25.472013Z",
"updatedAt" : "2025-07-08T17:15:25.472013Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity bf0234d3-ddd9-4da5-a4f2-a18021dc3233"
} ]
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/2b57dae3-7b3e-40f2-858a-8fe545f8d362' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJHaUNULWZYam9FeU9VYmQ5SVB4SlhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNiNDE2OTFiLWQ4NTItNGUzNy04MTZhLTJmYWY3NmNlZTg3YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkzMCwiZXhwIjoxNzUxOTk4NTMwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzQ1YWJhMzItMzE2MC00MjM1LWIyNmQtNTJkNGEwOWVkY2NmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTMwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Gz9pp9dewGq2K18mJ1khE-cUUENxAixu6Ydn7Kl91NO0KItG37YswLU-mxvlgeoiskkxL8CLA-DlPsJQ2J-11gofbfchgRePtpdj7sgZsZgC3Rs7MXpjpOiMTgVkH6LZ6EnaYHwyNkP8_HSfHN-oJpMFqkbHnecfyS8bloiN4lhcBNSRo7O0wecX4ZRHfu9f8G36hIoTdij8aMBMmsCRp9gOgUrTtfbbdQsXNbwZ-fmdC-k_yUJE6epLlaWPhloyBfB0C-B4sb71EElxVOAoZVkSi8GWS-patqaTP4keiwgMyMaNPh20A6mVAsTvuYVy7MyjqomBPSxJJQPN7HaaTg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "2b57dae3-7b3e-40f2-858a-8fe545f8d362",
"identityId" : "1f2912bb-74df-4112-b2cd-4dbe241d27ed",
"domainId" : "4871c4c5-dee4-4a84-8e42-b34482b14e92",
"createdBy" : "77bf4102-405a-4f2b-8784-e13887377e78",
"createdAt" : "2025-07-08T17:15:05.868908Z",
"updatedAt" : "2025-07-08T17:15:05.868908Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity 1f2912bb-74df-4112-b2cd-4dbe241d27ed"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJDcGtCVHpiOXlOYmtzSjdVS20ya0l3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ1NmEyNDcyLWIzZjEtNDU0Mi04N2EzLTM3N2FjMWMyODkzZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkzMCwiZXhwIjoxNzUxOTk4NTMwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOWM0ODM0NGQtNTljYy00MThmLWJhZjEtMjVhNGJmNWQ0MzY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTMwfSx7XCJpZFwiOlwiMWI0YjA0ZmQtZmMxNS00ZjhiLWI2MzgtNzZlNzJhNTY2NGRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTMwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Qn0CUOTzUmcjEZWs57FHoftne9PSWPMwuyEIUvQYeMTLCA5roIbopXq-2iXZuFjq1WE8Skekaqp97wUMkfNPGLItNwoKnzmpcHfkPLgZDkbGmz2NFL4Gjpig-a93iBXBjTuk7JgU7l0INvcWjgcJ4aUfDkIj2yNEKbEZ91Nq5uxXRYVTQCDwUsQ1nsPC3wq3c4VguWxhMdQrfIAi_BI1IbuEFzu81113_7791Yfa90XdfH5zYJjXMAR_jIzpiHUV1N74Gtiaoj_V4mXHMOhsfWsRfLGv27kfV3dNxXI1oXAmVOtw86BV3n_REZF99aw9ihBoZTEXWEnIKe5z5btTrw' \
-d '{"identityId":"1f2912bb-74df-4112-b2cd-4dbe241d27ed","domainId":null}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 488
{
"id" : "4bdb1313-7ca6-417c-8b0f-2ca3d561ae91",
"identityId" : "1f2912bb-74df-4112-b2cd-4dbe241d27ed",
"domainId" : null,
"createdBy" : "d56a2472-b3f1-4542-87a3-377ac1c2893e",
"createdAt" : "2025-07-08T17:15:30.489403Z",
"updatedAt" : "2025-07-08T17:15:30.489403Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 1f2912bb-74df-4112-b2cd-4dbe241d27ed"
}
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/be24f27c-cca8-4adc-95e0-fbd98b50b77a' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiI0TW1FWXNPNkprVmplZU9QZVVTYzl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBmZDEzNjFkLTMwOGQtNDE1NC04ZjA1LTcxNzUyM2Y2ZGIxMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkzMCwiZXhwIjoxNzUxOTk4NTMwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2M5NzA2YWItZDRjMy00ZGIyLTkxNmYtOTdiMzYwOTk4ZjMyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTMwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Zp4QxMzAd-tCC0vieaUiZMnndlu1mto_ZBPFy1ptoNWJ7ZbeyJ79wtR7ZDSIhsilRTJxKoxTX1AkXilo8LoJzDca34WUa3cg1bT7SdDomqHommlmX5T1ENVn-A4S_ZAT0m1hLJplJbppdvc9Tw05SA8Ow1e-lvonYCurAJDy3MH1ytEJAVZ4S1s3wJqHjttYks_Yh3kHAlSItaEi00aezx2sKvvx7sLeJ_5gGcVaWIzp-Nli2qTPizcCoZw_4pZj7xSvnxtwmNCTnnRka4ov_oS4z5IpdPfCuTkENl56EQ81nLhYPWsRpkQPa3A6581ijfnNwVLQCVX_DgrWC_6Xcg'
Example response
HTTP/1.1 200 OK
Public Grants
Find Public Grants
GET /public-grants
Authorization
This endpoint requires read
action on the public-grant
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
resourceActionId |
Object |
true |
|
isAnonymous |
Boolean |
true |
|
path |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].resourceActionId |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].path |
Array[Object] |
true |
Must not be null. |
[].path[].resourceId |
String |
true |
Must not be null. |
[].path[].resourceTypeId |
String |
true |
|
[].anonymous |
Boolean |
true |
|
[].type |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiI3ck05WnpYV3Q5SU50YVJsRVZldWFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ3NThhOTYxLWUyNjAtNDczYS04MjhlLTRlMzMwMDQyZWYxMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNywiZXhwIjoxNzUxOTk4NTI3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTkyY2FhMWYtMWJjOS00NTU2LWFlY2ItNDQ2MjNhOTM4ZGUwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.0_zvz-L74FuZJTTm0dirNv9_CQG0qhuoutmA_gZFNA5GQ5GkuzC0QMHE2s_BqvA5qshD_2tGdHF3sbbUWzi6CsWPeXlIL0oR7_w8vf-vpWM7X0mOGmVZHF9eRWoUDokcmiNqwGCX--N1JW-0nIqiuw0hJu0NY9LogSgZhs0Nfig3AmZwOZib7IMsX4TR4QdqqN2bcYio8dm7haURoYU9qlSd45ryY-PPrdnnNYrqLw5jUvhjnzbnZ5TImc2Nrcuwx0GGGqRPoT4Oq9p6zzRq3pXYfALDSUBgMamkFyRBgjUfvT6zlIDsTKRpuFi3mTwxAyFZv4bU6wH7-B5S-UVzrg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1479
[ {
"id" : "172ba4d0-2a2a-4a9d-8878-a4ce7c33d618",
"resourceActionId" : "8da49af4-c386-4e7d-93e6-6e6cbb7fdd82",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:50.238511Z",
"updatedAt" : "2025-07-08T17:14:50.238511Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Read Geo Region, All to All Authenticated Clients"
}, {
"id" : "2d83dd44-64d5-41e4-a00c-a83e81e29a96",
"resourceActionId" : "ee31022f-dfe8-4f3c-a7fc-8196ba95f9be",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:50.861814Z",
"updatedAt" : "2025-07-08T17:14:50.861814Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Read Domain, All to All Authenticated Clients"
}, {
"id" : "92c5946b-bb03-49e2-9b0e-ae97a7b5ca06",
"resourceActionId" : "a651c545-3b51-4858-9a66-e44335c06d1e",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:51.081951Z",
"updatedAt" : "2025-07-08T17:14:51.081951Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Read Network Configuration Metadata, 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 |
|
anonymous |
Boolean |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/b39145a6-5507-4fb3-8837-97962b61d932' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJLMkhpNG9NV0Z5R1piNnFLemtfa1dnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMyZjFmNzQ2LWZiZmItNGUwMC04ODMwLTdjOTNjY2E0MDkyOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNiwiZXhwIjoxNzUxOTk4NTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGRiMDk2ZDUtZGJjMS00ZTlmLWEwOTMtZmYzNDIzMDc3NjBlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.pQTdzYOk9pOhrDTb_a39QlteC3Nl7FBSaItFtER-fs5-ZHPKmykUFpGiVkTTC_YNd6LJ51Su8aTOu8PxSxdCgVN-FTVBQdm-tzY5QmWq0ZysBgPbTdjq3DPpe_ajZ1pp_ih2VtN3BQzvOqtUAThFOPQWRbMos-a-zZHVb6nNOErRbgOSgxJfb5gJyIBJc3NH0n_kyRhDgpKLmsyuc3ipqNKm1SNNTOX2S66mmNttXNPQFeM_h8Q0p7r1hieUjXG5iI3H7wP1KdaX5KroSwfcsUWGWhnAvHbt7uJQN5QJ6wotNMuGCvQoA6K7TQoGNXd3hOdVT02JmvZydqgJSSMhKQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 678
{
"id" : "b39145a6-5507-4fb3-8837-97962b61d932",
"resourceActionId" : "ac1e83d5-0a2e-4553-a962-f4930b9bf15c",
"createdBy" : "ac1b7f0b-fd50-4ce3-bff6-ec3855b55a4e",
"createdAt" : "2025-07-08T17:15:26.643248Z",
"updatedAt" : "2025-07-08T17:15:26.643248Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "14f5ff13-bf05-4bd4-bc97-65dc0aaa4524",
"resourceTypeId" : "2d48b705-5912-44d9-acbb-d418f79e57ec"
} ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action 46 Test Type 45 on/under Test Type 45 14f5ff13-bf05-4bd4-bc97-65dc0aaa4524 to All Authenticated Clients"
}
Create Public Grant
POST /public-grants
Authorization
This endpoint requires the following actions:
-
create
action on thepublic-grant
resource type -
read
action on theresource-action
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
resourceActionId |
String |
true |
Client must have |
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
anonymous |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
anonymous |
Boolean |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJwNzFLTTM3X213SkQ1QzBaU21CY2N3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRiMDEzNDU3LWQxYTgtNGM1MS1iN2QwLThjMjVjMTM1ZDRiYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNiwiZXhwIjoxNzUxOTk4NTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmNkMTkxNDgtMWViNC00ZWY2LTliMTMtMzJjODFlMDg4YzVlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI2fSx7XCJpZFwiOlwiNGU0MTE5MWUtMDBmNi00NmE4LWFiZGEtMGE3OTFlODQ1MmRlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ER_BBd3y9dFDQpBKgArVov49k7pzkqa69r8Ajc7bAbctaJWvWR6O_4fmbQbXiKRHDbDY60_l8Oke_4nJl-PRfLQz1YMWmnOq_4AX8D9_o02JI51Pima3IYnja9Dai0kFzWPV_VS8i-lxXBVaT9H8euU_t6UDEI3tmujIkorl4FxfW338yBUfgwcmi5LwliS7Eu9JaIaE87LEO_fL2J1Iyt8l1ORRHUDoplotN4gpq9RVeLuwU1Qo4czIouuJXgb37HshtVVek8pnE7CAv7NiupWYAt9KLqXQTgRgcE9N4FeFctk7NE0EJVHH9h-2bMRekosXFyzIw4_84CmOjadOOg' \
-d '{"resourceActionId":"a8e1801d-a04c-4bc4-a2f2-768d55d1d2a9","path":[{"resourceId":"4ef46d7a-f004-460f-95b6-5dacaaf83344","resourceTypeId":"8fe3be68-03fb-40aa-8bfb-857617b5288f"}],"anonymous":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669
{
"id" : "c1af15f9-7bb1-41df-aa69-647fe1be021a",
"resourceActionId" : "a8e1801d-a04c-4bc4-a2f2-768d55d1d2a9",
"createdBy" : "db013457-d1a8-4c51-b7d0-8c25c135d4ba",
"createdAt" : "2025-07-08T17:15:26.975242Z",
"updatedAt" : "2025-07-08T17:15:26.975242Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "4ef46d7a-f004-460f-95b6-5dacaaf83344",
"resourceTypeId" : "8fe3be68-03fb-40aa-8bfb-857617b5288f"
} ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action Test Type on/under Test Type 4ef46d7a-f004-460f-95b6-5dacaaf83344 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/2129bdb0-5660-4d68-922b-c6d5321d2ecd' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJoLXljMnBoMkQ1MG9DSHRYdTR0Wi1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYxMDMyNTgzLWM3MzEtNGRlNy04Mjk0LWQxMThkYTllM2E5OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNiwiZXhwIjoxNzUxOTk4NTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjIxMjliZGIwLTU2NjAtNGQ2OC05MjJiLWM2ZDUzMjFkMmVjZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTU1Y2VlZWYtNDc0NS00NDM5LWIxYTYtZTgyODFiMTcyNzg4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZqOREwibpn2jtWGne5CKVFdaRwdu4YSIOZIk7yy7nxI6kWbOK3SgB9Z2SexmseSxHwb3T9nnY4i_X--ylzjDYVGjRq9BO9-iZXB81qj0d1oc688Po9B1e0IExZdynJVgbbfifWO-CBf8hVOMM0TCiCVqmmEleKLB5d-h6MGB5QIUUsIvOzLPv3zPWQj245cqAi3g5SCTFZe5eLlFwpJLbgs0NN7ciolKO-WBq34atbQhnyyjvACUWxKyx5Q9GsS7dygDf7RfNgABvsgtJQ8cCDHySlWErRHQz8t7qLTD2vJBJSlS--o14XHRJMKute7qUa64iY5SEC3KJmwjwA7THg'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJQRWRoV2ZjUFZhSWR5NWplUFloR2tRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNjNmU3NDU1LTU3N2EtNGM0Mi05OGQwLTY1MjNkNDZlYmUwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNiwiZXhwIjoxNzUxOTk4NTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzQ2YWFmNzItMGMwYS00Y2QxLWIyNmYtY2I3OTgzN2E1ZTE5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.p53v10Q-4DeZa2BqkV0r_oe0tEJbRKL3bzyrKqy8EyFas4yXTW57DOceBKY-BJdW5MeoWHeGEt95wkRCMvQNNE4e1F9sagHchOodKUt9hz8YzpZsesHhk7QK5pqFbey3QSaLFfzMsyY39NE_FAzZ4PKq6cV2NC8Vg8x3QCbdlWRqYpx0HwDAd4ELxVWSqpJfYMn2GKt2wkAxf8EYKbAHvd-RyVL6dNJ3Ty4ckBljASFjodPlpQreM4yKH2ILTgDZCwIpWS4m2_SW0dgSwVIQuT6G8LC1nbX6_KqlwuOFPRDjtBJll1TcD5Yu8UPffdmZlw7k08xzTve9JVnEC3WaBg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1724
[ {
"id" : "47df3c3f-0ddf-4282-a4aa-07fd248e46f7",
"identityId" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"resourceActionId" : "823b1eb7-f296-4492-bcd8-eb39b1ab5be0",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:50.789379Z",
"updatedAt" : "2025-07-08T17:14:50.789379Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Create Standard Role Grant, All to identity 2b6f496d-36f1-4e66-a205-8abcf1d41d74"
}, {
"id" : "3723fd80-5ab5-4ce5-bb8e-63054ad53b39",
"identityId" : "c99d8b7d-1dd7-44f7-a7e9-f69b572d5092",
"resourceActionId" : "d31d8db8-7c2e-4926-87ae-d33abda6dc85",
"createdBy" : "b7cf5fef-db18-4dbe-acbe-662927755707",
"createdAt" : "2025-07-08T17:15:22.961937Z",
"updatedAt" : "2025-07-08T17:15:22.961937Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Delete Custom Role Action, All to identity c99d8b7d-1dd7-44f7-a7e9-f69b572d5092"
}, {
"id" : "57160626-1028-49c8-8d69-5bba181cf361",
"identityId" : "16f645d6-e5ec-4d27-a542-64891f58b3a8",
"resourceActionId" : "5430bd1d-33b9-4120-aaf8-8c94e8e57d42",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:51.956714Z",
"updatedAt" : "2025-07-08T17:14:51.956714Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read Azure Virtual WAN Site, 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/0b2ed256-d124-4158-b321-b743b0b48e40' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiIzZTlISC1rMHc2c3Jqcnp5cGRZRWlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkxZWQzNWRkLWVjMDgtNDlhMS1hMGI3LTA0NWVmNTVlYjEzNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNiwiZXhwIjoxNzUxOTk4NTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjU1MDcwYzUtMTdkYy00NTFiLTk1NWEtNDcxMTkyMTcxNDIwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.R--mgC3uxMZ9RMfUIhuQdcONXqIl3pslqrHoIVXOXGLcVP4JnzHoYtmgW6yFE4yBf3kbA9zDkdc5yFKcdwHcWA1TFKUW5ub5YcLz0L1Pezgbhj4THEGuVGQQlUH0LXLOURGcdYAss2Z4U92GkIJ4WAsI37OvTrTpPojOBujwpygCL6nC9URBLEVEcc6sEZ8fqoXPWoZHELUHlpNc8Fhf_felz3Pbq6BLV4BAiEZfaEyEd2bpSo35oh-e3ta_U6URpLRH2u1LADpnf73LDe3nG9kk4-zTeNEXjYNq9MPB2c2YNK2Spdk7K2Xoq7VCSjgJeY1scJR4uiloLa810rg7tw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 754
{
"id" : "0b2ed256-d124-4158-b321-b743b0b48e40",
"identityId" : "656b85ca-f541-44b4-88e7-ae355de6dc09",
"resourceActionId" : "d613fccd-f2f0-4307-82c0-bc6099c58c89",
"createdBy" : "13ea4720-1d36-4081-99c3-3ec881e56eb9",
"createdAt" : "2025-07-08T17:15:26.361584Z",
"updatedAt" : "2025-07-08T17:15:26.361584Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "6a316f0c-0289-40d8-aaf2-9f5e78e00b2d",
"resourceTypeId" : "64713e71-0ecb-4d74-9622-6bdb00ec7824"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action 43 Test Type 42 on/under Test Type 42 6a316f0c-0289-40d8-aaf2-9f5e78e00b2d to identity 656b85ca-f541-44b4-88e7-ae355de6dc09"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJ3Vm1xdkJtQ2FtTW1tY1VJWkR2TEZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk4ZDY3MzFhLTFlZGYtNDBiOC05YjIzLTM2YmY3MGNjMTUzZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNiwiZXhwIjoxNzUxOTk4NTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjdhZTBlYjItZmI5Ni00NTY5LTg3NzgtMTVlMzVhN2M1NDNjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI2fSx7XCJpZFwiOlwiZGViNWMwNzgtMmEwYS00YTk0LWJjYzUtMTVkNTU3MjNmYmY3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.3qLKWFrja6VoSfwHflfWN6yw3Xow1YVr64F-fZvOjSLpptErlULOEcomdDVnRVMBrW4fiv2agB2C-5oor8_r4S0Sqb5Z4Juh9V6nJwOWKXZVoe9CWW1IhnXIPnBv9u_p1f3dgJYCAVI3yvMDXSSweU3c4r8my5S4VK6TpMHreUsKmnEm5BFxTXRPXuHH2_RLWJBvKZDQ1xLMJqq1ijmXRf2ZHyg9iPFIo4WooLMk6JdlD6udYWT_6H5TzfMWmIMzEUW_q0zty8HELMXdNH22fpAMfQ7KkbU5sv2lyi0wsXTvB_T9XAosXrVhkzBO57wWl9j_wjCclfOY0yWnyQFUAw' \
-d '{"identityId":"b953a583-2e04-4012-9fed-6bd955447ee9","resourceActionId":"a8e1801d-a04c-4bc4-a2f2-768d55d1d2a9","path":[{"resourceId":"1086ea0e-df19-4fa7-a348-f5800d03db98","resourceTypeId":"8fe3be68-03fb-40aa-8bfb-857617b5288f"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 745
{
"id" : "d25d9c12-9dbd-46c9-9f34-349be6b1ad78",
"identityId" : "b953a583-2e04-4012-9fed-6bd955447ee9",
"resourceActionId" : "a8e1801d-a04c-4bc4-a2f2-768d55d1d2a9",
"createdBy" : "98d6731a-1edf-40b8-9b23-36bf70cc153f",
"createdAt" : "2025-07-08T17:15:26.528691Z",
"updatedAt" : "2025-07-08T17:15:26.528691Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "1086ea0e-df19-4fa7-a348-f5800d03db98",
"resourceTypeId" : "8fe3be68-03fb-40aa-8bfb-857617b5288f"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action Test Type on/under Test Type 1086ea0e-df19-4fa7-a348-f5800d03db98 to identity b953a583-2e04-4012-9fed-6bd955447ee9"
}
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/770cfdd7-80bd-4f10-90a7-114c4529033d' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJmUF9MU2tEUzdQbktrMUFqejFFdVNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY5NTNkNjkyLWMxZjgtNGRkNy04ZGYxLTU2YzM3ZDU3ZDY2MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNSwiZXhwIjoxNzUxOTk4NTI1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTBlNTkzNmUtYzZjMS00ZmI1LWEwMmEtY2ZlZjBjMzQ4OGI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.R-FRZvhDxtYcrs9Rr-5af5iKnBpvs3KLCSX7XRPfRn5cQqE5qT22f6rlcmtYN9s0IcPuQG_cvDtZFcynypq2DhDdbX83vEDp9TbEtqbPZw18zujp364u85mJsSCy79FNZhL5XiNKQhykxL-EqYAKqin4gFA2j-tyOJCrKVEJnU9s4AhMkTcsacm9YsjEtC8PvHGH5tlqr-Gjy3BvQT4bZHCziY1Rj7Phg1scT1hi0a9vYpSUa6KfRtUl6m-0sP9Jfja8O5-GcqFPuacdaesnUzKbeH0mbeVPHt9mdMeizW4T7rg2msBT6DgL9sIsFNwI7G6PlB5QcuSFVOZRoJOxaQ'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJJQV82czB2OHRBb2tWSjlFTVVnc2x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM5ZmY1MWQ0LTE1MTctNDdmZC1hZDkwLWRkMDEwYWIxNzJkOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMywiZXhwIjoxNzUxOTk4NTIzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGE0NjdmMzEtMDA5Ni00ODMxLTkwZWEtZTdkOTNkYjkxODc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.o2mLEQdZuANDYO9PV1XlZ55KDhjtf0419hHjBAbo5sxDrI1x9Bp4_n1je8vakZ3MCKdlW4ou1Zpz_Igpq9QOcG01wb1mMMFxpFB6M2YemDYlWNSKuYxKJCxZwwRxjJe0GuxSdFgk8IPVw51Kq6bI0z8gpZMyaPu8UPTQbe7a3RHhsSaAiYwauXD9uQPgUq3HswGHJAQj7Kjpl4q1YdSvr9tXUO7GglOYOlPlV0buqLm2PE2E4LMyzZrVXPKfaQgHF8nYZGvxPchpWwaWuMY891hBIunXA_dl90k_os58tBOwWgrJnTFt-k-G0lgbDTB72snfOZ_fNgJFvuuFWlFBsQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1155
[ {
"id" : "c88f10f2-61d2-458e-a156-7bf270fc31d4",
"name" : "Customer Signup",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:54.483283Z",
"updatedAt" : "2025-07-08T17:14:54.483283Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Customer Signup"
}, {
"id" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"name" : "NF Support - Intervention",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:53.982720Z",
"updatedAt" : "2025-07-08T17:14:53.982720Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "NF Support - Intervention"
}, {
"id" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
"name" : "NF Support (Read-Only)",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:51.098861Z",
"updatedAt" : "2025-07-08T17:14:51.098861Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "NF Support (Read-Only)"
} ]
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/221c8e29-c9e1-4274-8c4a-cb7debcf39ae' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJlemxyZDJ5ZjQ2Y19xN3ltazRyVm9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg0YTdhZGQ2LTBmMTEtNDFlNi1iMTJiLWFhMWEzYjFjYjVlZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMywiZXhwIjoxNzUxOTk4NTIzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTExMjNiMzYtNGEzYi00ODZmLWFlNjktMmY3ZGVjNzAyOWY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.icfwuA3yezMwrnD505dkYfriYUUtfCyUbD2q31ZCy7dNThsnDKaZ71ZJqAGSoBFfGmbD0AbmZLnJi4i4YhDhO37m-1Vo2RNw5m2nIjPITdgbaAginFb1X7V-etNybFnmW7yXL0_v1-Yje4p0osXcnk9rkdOsx-EET5wb57SFWPxjtHrPJ3s3QXks5tA9l7hdRJ6_7JCGCWmnKdFKSWve8Zzcg8WcDqHTbz1WcX47-nClfART9lRLdqvmq1xpO_EpDSovio4dQvt3-kYD1d-Mmy9QSPl2UfpLuRY61iz2oC2-zmAMEuW61y4r-uUQyQbtJl4DomLkyVsYHMx6UReXhQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 379
{
"id" : "221c8e29-c9e1-4274-8c4a-cb7debcf39ae",
"name" : "Test Custom Role 31",
"createdBy" : "493e1d3e-c8eb-48f7-aa80-317d21ada559",
"createdAt" : "2025-07-08T17:15:23.086359Z",
"updatedAt" : "2025-07-08T17:15:23.086359Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiIwM0o0OWlyR3V2RWZvanE3T1ZaQ3NRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFmNjBmNjg4LTdhOTEtNDZhYS05MDQxLTlmNzA1MTFmYjFlOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMywiZXhwIjoxNzUxOTk4NTIzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTNiMDNiMDQtZTkzMS00ZWJkLWE5NWUtYjZlZjA0YTllYWQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.hjBKqDg14nIp_dtFcW1HaJ6Bp14rvVu6ItIVwh5IqSIsbgn2obfvwpAT0Jq2dHPvsbFwa_VZ9GPzCbMy3SH3ueFndsBKXg5Ax1TSJkCnMLKo0oAU9v4VskcnlQSBA6f6l8EhNLUwML8R7jfIHPuvo_3htto3s3Bq-XeUaKkbg2MF-MGeUbTFnkQRgH0VESn1Pl1zzvB_-xytFnVkjMLq4zqT4XOCjOIr4W4zTPpURE1ZoOcj_-dfgjP_6SNu1xE007DnFhAokEKQe-Rzb2MntpKbAA4rg5eVLbrR4JSRNVSs6Y5DjBWq9DAfOILsCbMDBTRjqAVeb-KGjwmvguMoeQ' \
-d '{"name":"Test Custom Role Create"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 387
{
"id" : "70c5e2f4-7cf5-4926-8bc7-e8505ba1768e",
"name" : "Test Custom Role Create",
"createdBy" : "af60f688-7a91-46aa-9041-9f70511fb1e9",
"createdAt" : "2025-07-08T17:15:23.884607Z",
"updatedAt" : "2025-07-08T17:15:23.884607Z",
"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/58438559-b16b-46f6-94c4-f4fcf95725c9' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiI1aHZwR3pDRTdzeFF2S3U3dEI1RUN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFlYWZiZTYzLTNmNzgtNGRiZC1hMzFhLThlMDRjNTAwZWU3ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMywiZXhwIjoxNzUxOTk4NTIzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGMwNjU0NGItMmIxYi00NGE5LWIzOTEtNjQ4ODkyMjE5MzlhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.szllgRUaR0kElYnIx8I5_GysBzOOMV9svgulJerl8gmsVy0ctva1oDRPex8up0nt6DCBky3MG64fPkc9M6xwsfgWfr7PZeUAfaOWYyBx7TbXqbdZQIzBlt-xVhfgQpxYhOcNY9bQ9sW3SXgK5pAtjrqAL8-mxAaRI3PnAmNwU3rB6tWlc1GbKLUugF3qUMeSt5uGim_qD9FCvHIUIbMLcboMU_vmR-lMbifKzzL4QjFmDSPRFvd1dMxz7cLdY0NvL-_byPkfN5himuYFliSHQRHo90yd0Q0CKuLhSAHZhUs8l9a9J49mGxZEZNRnvVRDx87iEvMBLnZQc-mKaSiEeA'
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/989c5ca5-f22c-4d5e-9539-8cb0701ff65b/identity-grants/34494c08-d8cc-4c5a-a51e-cbeeade641b0' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJCS3RkajZUUVRQM1B4TDlnMS1uN1dRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAwODcxN2UyLWMwODktNGFjOC04YTIxLTk4YzAzMTA3MjcyZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMywiZXhwIjoxNzUxOTk4NTIzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGFmYjExMGQtNmM1ZC00M2FkLThhN2YtYjUzNmM2OGQ5YTU1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIzfSx7XCJpZFwiOlwiOGYzZWU2MzEtMDI5Mi00Y2VjLTlhNWYtMTQ4NDc2ZTEzOTBlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.0fCBOdr7YDGFxvYQeySwA6Kh_HFxi1gH5peXF6TCbfytHLhuv_z4J_cqKVcmSRSPYej_w9CPORzM7Gg5tC6Fl0iMYXouhndSG6NU6iNm-WwmV52XMott7AA3vbq49ga03QXH1zGn6L_708AhPZtaEfYHoJh0tDZl5rTqueHEIC2PbFwOEgdvF04gRTz7EICMcfVxFiPh4dqElz-1hNVaOhPctsbcjaF9y96M0lzTFryvJANZ6DbDbGscf30jcqsZnQn_TWdajSvLAL-gd6t6L9NTBfviLMzOulzSEGoPDCXkeaLYHJw2nC5gv2PsK1ls8J2xtGCG3oLJBnjptNjrLQ'
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/cd860192-d1ec-434b-897d-f16875c0f4e2/identity-grants/cd30ee19-c1a3-45e0-bbe0-0f493a221c08' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJBSnVVYWhKVEFLYUJXVHJ5UGhXR2R3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQzOWNmMzkwLWRkYzctNDg3ZC1iMzkxLTJkYzJhYzY1M2ViNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNCwiZXhwIjoxNzUxOTk4NTI0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTkwMjBjY2UtMzRjNS00YjliLWI3MjMtYTMxNzBjYmU2YjMyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI0fSx7XCJpZFwiOlwiNDBjOGVlYWYtZWIwYi00MzU5LWJkZTItYzk0MGU4NWJhOWU0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.X3ziHERySB_5VCoWJ15Rv0jBH3rmEuNikW5fjwAn9YABthDyhM1lEIoo9_RP6fDWaIC-r3lqWrLu4cdwJi0GCSah2XxwC-6bjIk2SomaTTCy5F4qcuI9gZiyZIVqu980KvxrMBN9ZtaDw8CwkKTxc3DpFyMJZcB8N9pf6-jvmecAOF3SioRtZCngP6pTkuJCGPq13V6GaLjNCJZDo9bLaU9fFDQgG5ixHZb1WDp7o01eFRYhHJs3RI0c3DyZWQGsM7-Cw1nZ9TizcnOiAJpTuUtXBmyKw3pdhukbi4Xsnua-L7wPGrfVCW_Br8JsUZGPlHBHWof4nFTdNS5iCrx-YQ'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJaRXBkRFFZRkZtczBlaF95QUVqUGNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhhNDAzYjVkLWM0MzktNGM4My05NzQzLTM3M2Y4ZDM2N2JhNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMiwiZXhwIjoxNzUxOTk4NTIyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2I5NTgxMzEtNDQ3OC00ZmNmLWE0ODktMDQzY2NhOWU3Y2RmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.5hjvoIbZplnk7faoKBDktpDBnF-c0qzHoQrqOUmIke90GBvjbJrpbZ047zsqT1F5mXT4IHiW8zBJvb_Uuf1nBYOVhxNBL-XvmLy1H9X34QAwRN-qABuVkwta5xS4GZbtiC2_TlMHZsILViC6Y_NDwUWWUWoXOE8orLNjVIXOJ61OfeVrmzPCLOi9SRvnxoalTUIdttVwYaeuNoAuoP5OYUoZJSdEZ9g4iqfTvhL7PjwzUGP1KYx5LAaFVEvyBwDQlvtPGb_srniuU_D38pHfzRgu13w8llHjjwD1BCiyv10JxVlgNQCqIpRX0cuSrqCHP34s9Xp8HFQeONOqAjaIsA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1290
[ {
"id" : "b6cbf05b-ba08-4717-99e2-3421e8611aa5",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "36473dac-ec8a-4d87-b6bc-8007ec81954e",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:53.988385Z",
"updatedAt" : "2025-07-08T17:14:53.988385Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Delete Browzer App, All"
}, {
"id" : "e0dc7f1d-e300-413b-b309-a4f3f3468838",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "0a82062f-6f84-4137-8cb0-1b723ccc1818",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:53.988385Z",
"updatedAt" : "2025-07-08T17:14:53.988385Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Create Network Version, All"
}, {
"id" : "a58ed5c4-d92f-458d-ac53-e0a13c3445e6",
"customRoleId" : "74a9a6c3-106c-40bc-acab-780c837ad8d0",
"resourceActionId" : "5430bd1d-33b9-4120-aaf8-8c94e8e57d42",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:51.256067Z",
"updatedAt" : "2025-07-08T17:14:51.256067Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Azure Virtual WAN Site, 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/73887755-36d4-4589-86fe-3c383d9ea8d1' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJ6VEYwX0t6S3dyRUJGbkhaTktKY2FRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFlNDhhNWUxLWQwMmItNGU5ZC1iMWE3LWFhYWQ3MTg5MTM4YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMiwiZXhwIjoxNzUxOTk4NTIyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTlhNzk1MmItMmVlYS00Y2E1LWIyMzUtODgxNTBjYmIyOTM5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.dkB7Ptvu0GLGzasu4TdwbtaFE3dP9c6h-vUoF_TGHlvNP9xV3RMYhO7ABXIbieg661nb_KhYPDzT1b-n8KOGxqpAcl9IPoFZOkEwrwxng0esQoLcFhHHEnv_piI2JetOaZPuv2LJXjh8yDW7IeAEwIQDfbpRqIqEkCS-iIpZIWMkXLAVE_jcmmPb159VYlC9TsXcKNHwJ4bPmmV5QmtiI-eKcXcSAg26zUw6Qumk3j9VGDar8jyxW9Es5017dNq6yRv3MuoDYzFEOJzAKdpEu9nDW6Bgaqrxl86tvoAA0EvHJSomHLR47Vgfm34hP5sCE4jntIcaD7QqfMirBB6Pmg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 613
{
"id" : "73887755-36d4-4589-86fe-3c383d9ea8d1",
"customRoleId" : "e8206e04-ebda-4978-8a79-1b558c2cacc4",
"resourceActionId" : "06572686-d134-4e8d-8c22-43dea9acfe96",
"createdBy" : "9b24761b-d7d9-4c35-be18-a78f667d02c9",
"createdAt" : "2025-07-08T17:15:22.347088Z",
"updatedAt" : "2025-07-08T17:15:22.347088Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "438e58ac-ca8b-4809-a2cd-d7290cdfaf27",
"resourceTypeId" : "3f9846dc-8efd-48f2-9fd2-2787d53e6e7e"
} ],
"_title" : "Test Action 26 Test Type 25 on/under Test Type 25 438e58ac-ca8b-4809-a2cd-d7290cdfaf27"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJKUUl2S2xhdFZ1TkFsd1B5bmZjbmtRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ5NWY0ODJiLWZiYzItNGRkNC04MjE3LTg2Y2ZiYzU5NDUzYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMiwiZXhwIjoxNzUxOTk4NTIyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTBiNzE3YTAtMjJlNS00ZjY3LTgxMzUtYTYyZmFiYTIwMzk3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIyfSx7XCJpZFwiOlwiMjRiZDg0M2ItZTgwOC00MjY1LTg3NDMtYTZmMWNmMGNkY2I4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIyfSx7XCJpZFwiOlwiZGZlN2QyODEtNjIwZS00OTk2LTk1ZjMtMThiNDRiNGJhODdjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.2ruiHkwn1dQIkCMFy6w_1GHPYaU8AcR6ma189vgjHQOoRKwRO-Jcr66tL25tOs0Hq_Qp0ZUDMv2pwoQcH3rrDGnJwbRnukl89t19a2swMQsHy4L61yhdFAG1hBVERtZve58MLysgy1yyEy3mVmR5IOWuLwgHNJqfQTQNYuE8CXyjbwSIH__1Ckf4fZQhyfk2AOriKQcMhQmEaO1cIjt8gAwxA2Xin_eyfz-8SEdCu8vssbZe6zzaevXVi9TBxwyKL9mQGvoRMxil99LE1PDn6cWQuKmUsjQtohVHHSbkLvrdmhXyUoht6wwlurCXHvlYcNKDAeA4kJFQIl3uAQA2ww' \
-d '{"customRoleId":"bf58e1d4-2c9d-4d70-b08e-0f2b2c967092","resourceActionId":"a8e1801d-a04c-4bc4-a2f2-768d55d1d2a9","path":[{"resourceId":"a448d0f2-0daf-4770-a7d8-fcb1d41fd3f3","resourceTypeId":"8fe3be68-03fb-40aa-8bfb-857617b5288f"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 604
{
"id" : "4443237b-8e09-4032-8ed2-486a62fe2ae0",
"customRoleId" : "bf58e1d4-2c9d-4d70-b08e-0f2b2c967092",
"resourceActionId" : "a8e1801d-a04c-4bc4-a2f2-768d55d1d2a9",
"createdBy" : "495f482b-fbc2-4dd4-8217-86cfbc59453c",
"createdAt" : "2025-07-08T17:15:22.173061Z",
"updatedAt" : "2025-07-08T17:15:22.173061Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "a448d0f2-0daf-4770-a7d8-fcb1d41fd3f3",
"resourceTypeId" : "8fe3be68-03fb-40aa-8bfb-857617b5288f"
} ],
"_title" : "Test Action Test Type on/under Test Type a448d0f2-0daf-4770-a7d8-fcb1d41fd3f3"
}
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/4aad13e7-e981-4aec-ad95-be09a83fe73a' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiIwZjdWUUhKakRETHpUSVQ5RDFlc1hRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM5OWQ4YjdkLTFkZDctNDRmNy1hN2U5LWY2OWI1NzJkNTA5MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMiwiZXhwIjoxNzUxOTk4NTIyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzcyM2ZkODAtNWFiNS00Y2U1LWJiOGUtNjMwNTRhZDUzYjM5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZTTonFKnlRA1Wil80E9rsxcGEH_5aNyQvh4yYiZRUqWt9f5AChK7p1rgcIgnCQcLQs0fGs2R7ds0aihe2LyMIerpXvcpYLw-xZUkdHQxZwwv5KEbAu5OCLHHxswZ2N86LucALMZPlheTJ0CdjDZ8QB8_7E9q0UKzw2kKuBIXFOfEX6c38enlnaNu97L0dvS6eAtOVzumqWbNhhXlsqKbi37i8z5gpc1BIK8XCXT7s5YgcuyOG4RpwkInnLCke1Ew5c5ORZoZagei29DvVs3792yhoCCU1_VeDui03WWy5Z9Q_Q2hlmz_PvTvD5O8wgj4XxNjELWDhyjNFknZ0a7-OQ'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJLZV9QR09iN3dLdjdGcVUydkZFUS1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE5NTM3M2QxLTZmZjctNGVkZS1hZmViLWNiNWQzMTZkMjU0NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNCwiZXhwIjoxNzUxOTk4NTI0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTUwZDRjNGQtYzUxNi00ODRjLTk5ZWYtZjk5ZThhZjlmZWJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.rE3yO4EzW2RgUwPso5Gw0KJwgGOrdGgBZP7UuFgVGJ5Wh-TY3U7N-cLBTrssWLwuT_mY-GyztNRLVmlkBpX-LPY6Ny8C-utX8RiFS96IKXXSJWZFttYEB83Sag60Ny9EPxvhnc3Ux3YPAo5FPqHNKz0pRRog_Bb_-leZ1bOQN8r_ThKivitR4o1WMuhXO7395q0mgJXJKno7SJlvNif-xnEyo9C1Xt8wx7Ldsu37PdPd5zrDCMg1on6Er0bb1mAmhXgAKIBV8xcHAUbZgVKsYSX0QrfCAtX0zScFiGchl9kf20bs4PK5i4-hSvawD2B58Av-KnPQOqRNYjE1GFabmw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1415
[ {
"id" : "04c08ccf-662d-4d11-85f8-90e33efb4f90",
"identityId" : "ee5fd55a-ed48-47b0-aa65-dd49be01750c",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:52.922558Z",
"updatedAt" : "2025-07-08T17:14:52.922558Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity ee5fd55a-ed48-47b0-aa65-dd49be01750c"
}, {
"id" : "abf869b8-3bdf-4f53-9bd8-f51e2fee5fc0",
"identityId" : "48ef8928-4f59-4428-b4df-83cd7ec770bf",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:53.247842Z",
"updatedAt" : "2025-07-08T17:14:53.247842Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 48ef8928-4f59-4428-b4df-83cd7ec770bf"
}, {
"id" : "9a025bef-18b9-49db-8a65-3ed352a6d7cc",
"identityId" : "50f24a8c-4845-4b69-83a9-00d53f1d7da2",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:50.759333Z",
"updatedAt" : "2025-07-08T17:14:50.759333Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 50f24a8c-4845-4b69-83a9-00d53f1d7da2"
} ]
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/b81b13bf-c3b9-4b89-af00-7d49ff496c64' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJEZ1VVX0E4VHdPSnZhalROZ0EwYzBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZkODQ0MjliLWY3NWItNGNhYy1hOWQ0LTYwODVjOGNkNjU2MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNCwiZXhwIjoxNzUxOTk4NTI0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTk2ZmM2NjUtMDhhOS00OTYzLTlmMGYtMzVmNGNmZTk4Zjk4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.gTA9XmrtD-CRAdUfNCLbichVy9yMO-AZNckN2I8kakNPvdbQfTp9JEG4NNNWwRmzQxu09BoGCkxtAymr_GuL1lZYi2e9jdfvL07zb1yTznlpPwH8IogbPTxI4rwG60rWBk4hjfRhF1qtIEJqo-UgytlXX0IT3fTs_F_czK_gsU3MrieT-F0Sb2_RcimeyxNMI008PhGZPKPVOe9ocawQNEmusn4RSSUlWr2FLJnDRITmdhxGJa_oWoDKMTw7b3UspfnbXCMmuLlHWaFyRkSRFC1BqSLxEF3BX2t8k5pgLL0prU-i_iRybWjZPmKZrBW-ZgMhN7_aTYH5RuUdjiVyVQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "b81b13bf-c3b9-4b89-af00-7d49ff496c64",
"identityId" : "eadcb416-b7d6-4bbb-b2e1-6250c65c8df1",
"customRoleId" : "ceb1b728-5c14-43e3-9594-f757a5a3d411",
"createdBy" : "24c9df0a-1654-4aec-9084-06aa6ea60da5",
"createdAt" : "2025-07-08T17:15:24.191260Z",
"updatedAt" : "2025-07-08T17:15:24.191260Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 35 to identity eadcb416-b7d6-4bbb-b2e1-6250c65c8df1"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJTTTVCaGs0QkYtRFVpMjluXzgxMTF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM1YWM5OTQ1LTRlM2UtNDU5NC04YTBjLTE0ODQ2Y2YwNDg3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNCwiZXhwIjoxNzUxOTk4NTI0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjljMjFjNjMtZDEyZi00YzBmLWJhMTMtNDkxZjM0YTFiMDk3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI0fSx7XCJpZFwiOlwiNzFjMmRjZDItYTcwYy00MzYwLTg3ZjMtMzZhNzQ1NTI2YjZmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.RCpCGU6ZF_A5Zql70a89YJd0QtEAv189w5burlEf4tuTj4XgiZAqnINdrO16orgC9R5lRsP7EBmweBjMf3njlW7IgBYTAmSId5T91pUZunxpnyK6IRel02fEGnukrPni7snfkGTAmIMqQ3yWRDllEkgkCbv1St2QZXZ8Xr4N6LPZ5hAyJs6Nlz3pTW-Mk-0MFmValNVZjWRc5nog_zVGQGw-bz4GaDbGNL1HbT3JXxW_DyZ2gwM8Rm9q4NWGMbNfH2_mrV57FsvvzAIYc8w94HPNko4Bsbq8fA9LxCze6owPQqmpCCcuwD3VZqI-ue-iXzB_G-fvGLG5cNFXh5-rlA' \
-d '{"customRoleId":"3cecc1b2-72b7-439b-b585-940209384a1e","identityId":"6aff17ff-b695-49fd-b911-2f3f5098b073"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "8ffefaf8-b4e5-4544-8cb3-529b50ec4fb2",
"identityId" : "6aff17ff-b695-49fd-b911-2f3f5098b073",
"customRoleId" : "3cecc1b2-72b7-439b-b585-940209384a1e",
"createdBy" : "35ac9945-4e3e-4594-8a0c-14846cf04873",
"createdAt" : "2025-07-08T17:15:24.641040Z",
"updatedAt" : "2025-07-08T17:15:24.641040Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 37 to identity 6aff17ff-b695-49fd-b911-2f3f5098b073"
}
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/7de99af0-6b60-4606-9393-14e669f89020' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJYSEoweE9RUWg0dHBsWDAxR2tJVENRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg2ZjE2ODVmLTIxODQtNGZmNC04YWNlLWE3MjYwZjE0NTM5MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyNCwiZXhwIjoxNzUxOTk4NTI0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODRmNWFkNWYtYTRlNy00ZWU0LThjODgtMTYxY2FiMGJmY2ZiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.NMr9j2LCWbNJuKHvMEP9apzifcvO5wzDDWIjiUT2xG2s_RYWGs61sRCcdjK6BjR1MGq9i3TqkTgvCKj5RYbN_x7lpy1tQwsuZSGdJPT9UunRm4OmDSOp98ht6riISJWk0dACPRNyCzwBm5vDkkBI3m_Rh_BcNQ19QIFlXN3oSr6kYMxWw79Nu7D1gM6aO67Yy3jrRVM8uB6iPIspkX0JAcWDKc-xYlkjhZSAeECCWmN6etJTVyRZGPxXJpC46KeT_uDMRIAAtj_7Jso9FNdIUwI6McdLDkAxNzdfVGXPzf5U2s_5J0HBNB1TXD5MPiDJrDweUEUIBNTVBYTvaxWcbQ'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJRMzVOSDRIcDF1aTlubkZJNU1MR0FnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZmNTNjYjgwLTlmOGQtNGJjZC1hNzFjLWM0YWUzMmZmZDJkMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOCwiZXhwIjoxNzUxOTk4NTI4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjI0NTM5OTYtMWY2Yy00NGVkLTg4MTgtOWIzOWJkZjVlNmVhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.kNtQxG1Nx_IA8rIp0RfPe3DBxiUop--RTfcGHGxO6iSlOWNI-GKhBLUE3cfe1ltOe9koGtohkZhfvZKFJP3mefvdUF6_NJYrwdY_akVdCYMWmX9_Ehv1pnlihq6pN8vLOgs_v-FHbax8Ii4429LXy0sptW8sr1JtmX5HH33GRaM2zcsCviQz0_hjFSJU_Jh-hF4-19rUYgwPERaqJyfGm7jWp6ZwJh1D9VCVb8-pzCl_4mRBrg6tSViD0eFMANQUmw8bazdnBLHoI1DDgatWuukCTkRrH9vP2OoGmzgiJHOLMaYKG0xZtrSH-Cz8N9i7j9iEu2BhGSTHnMWy2xqaUg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1923
[ {
"id" : "ddd39147-0ce2-473d-93c7-25b1b404433d",
"standardRoleTypeId" : "00b1186d-f86a-4503-8dc9-a9e8e8fa3525",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:54.030994Z",
"updatedAt" : "2025-07-08T17:14:54.030994Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "76081ba1-023f-4ddc-bbf7-4d8ad08b21da",
"resourceTypeId" : "35f0e863-56b9-4d95-b325-4c771187c172"
}, {
"resourceId" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
"resourceTypeId" : "ba0aec91-b409-454f-90ed-3c2f888c1e90"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Standard Role Admin - cf53e966-a3ad-4e80-a5fc-380fe8d48e57"
}, {
"id" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
"standardRoleTypeId" : "76081ba1-023f-4ddc-bbf7-4d8ad08b21da",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:54.029636Z",
"updatedAt" : "2025-07-08T17:14:54.029636Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "f0428619-11bd-403d-8b00-a463ff8aad84",
"resourceTypeId" : "793a097f-ab43-450f-8c2e-b76e965bde6d"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Network Group Admin - f0428619-11bd-403d-8b00-a463ff8aad84"
}, {
"id" : "275fa782-c551-4d49-b994-c86b6e4f1318",
"standardRoleTypeId" : "f97157be-1e6f-42a8-be38-614912e62f29",
"createdBy" : "7c6bb7ca-dd9e-49d2-9612-82c790cfc060",
"createdAt" : "2025-07-08T17:15:28.217922Z",
"updatedAt" : "2025-07-08T17:15:28.217922Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "e6d116fc-4e1d-4afd-aff1-d300a827636c",
"resourceTypeId" : "1b193c60-0fdc-494c-91ab-e165a51fae42"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 51 Admin - e6d116fc-4e1d-4afd-aff1-d300a827636c"
} ]
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/b2ae2280-c2a9-4c3e-a6f7-a6a6a0538ca3' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJsaVg4b0NoRFh2bmRXLXhGUTZmVnlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRjZjhkYjJlLWEzOTItNDE3OC1iMmNkLTEzOTE3YWZiMTI2MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOCwiZXhwIjoxNzUxOTk4NTI4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDhhNjZmZjQtYzk4Ny00N2ZiLWFkNzYtYmUwMzllYmQ2ODA3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Qr0IyajmwRDHlcS-tg6yz3ato4nJg6IrJpJZphzvemi9geekjxi4l4CB0-Y_yzsZDz5vh3o0mku36cN82VAGfGfhKQnQA7kiBth5LXmX3-ObfsBZ5OhG-rDqD0o2g8PugTPoBqvAXl1Wvae6JA7AfZBM0L3GfpBm2BJEsUzPwEShUE-R2h35r6jpPg8tOgTVOuPdj9oNnHKMFlk8oeNMMkpfIRF10A-2Cglnb6EOwpWB_VtvF90oDjBk_YPnFeeYLqDq-jEKPTWjVF4UAV7k2FanEUDij5Vj968PZQcIIb-hp-HhaYrKzuQKhMUnICCUtZpzMcD0n4f83wCfmZUR7Q'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "b2ae2280-c2a9-4c3e-a6f7-a6a6a0538ca3",
"standardRoleTypeId" : "79f5ffd2-9cf5-417e-9461-9306324b8aab",
"createdBy" : "91223699-3524-4feb-823e-822e80b9f84f",
"createdAt" : "2025-07-08T17:15:28.577844Z",
"updatedAt" : "2025-07-08T17:15:28.577844Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "835860e6-bcd8-4b3c-8ad0-b89bd8d048b6",
"resourceTypeId" : "efcc0ce5-0a60-44fe-80e6-6cc687f7df02"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 53 Admin - 835860e6-bcd8-4b3c-8ad0-b89bd8d048b6"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJZSHAxQ19VaFNSNnRRa0wtd18tdnZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdjY2M5Mjg2LTc0OGYtNGE2NC04ZGI5LWE5NzMxZTQ4ODY5NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOCwiZXhwIjoxNzUxOTk4NTI4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTA5YjhhMGUtODk5Ny00ZGI5LWI2NTAtNGFlYWU4MDc2NWJiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI4fSx7XCJpZFwiOlwiMTY4NDMzMjgtN2Y0My00ODZkLWE1ZmUtNjI2MzExNGZiZTk4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PE7JeGao4r9wxJEC_R4Sud-EW1fLIzt15ScqEvr8DhUB8MuhuFWXEUyuk-X6MMrWP7fqxfnvCnXlijWcjt4qI6DKzADm4zkFE8JxPvwKZH5_Vy2jyJ2iWpnA4Dx3CQuFN_vC6dq2OhMC3g5S8wzk04_H-20ooviJUii9xBN8LKYt-4HIbOsifQshEdQLlRE7katosyengKtVSyVslv1xs5-cJKEmRasInRQlOR60vuKeADt9isVkPmRnZSpdYUCxEbWC-rPIIGVJRtlsD31BWC_NnWtynYbMTBgufmB_Pes4j3pw8GU19vqUoLaydtu40cvIPKQ4UF7eC31pxIPEUg' \
-d '{"standardRoleTypeId":"ead47cb0-c757-483c-8b57-f5111bfbd769","path":[{"resourceId":"7604520c-4281-463b-beb2-16f024889380","resourceTypeId":"6fb784dc-ec91-4473-8a96-c0fbe4a2d377"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "e8584235-c931-4db7-9d6a-1add1cdf0cca",
"standardRoleTypeId" : "ead47cb0-c757-483c-8b57-f5111bfbd769",
"createdBy" : "7ccc9286-748f-4a64-8db9-a9731e488694",
"createdAt" : "2025-07-08T17:15:28.786347Z",
"updatedAt" : "2025-07-08T17:15:28.786347Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "7604520c-4281-463b-beb2-16f024889380",
"resourceTypeId" : "6fb784dc-ec91-4473-8a96-c0fbe4a2d377"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 55 Admin - 7604520c-4281-463b-beb2-16f024889380"
}
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/b2caa0f9-f213-4fe7-8cf0-7e5d572c466d' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiIzRndlZ3FRbEtrNFl4WUFLWFREY1h3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFmMTk4NTk1LTA4NDMtNGVhYS05ZGVmLThmYWJjZDA5MmU5MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOSwiZXhwIjoxNzUxOTk4NTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTQ0ZTg3MTQtNjIyZS00ZjVhLWI1YjUtYzUwN2UzNTEzNzEyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GIZ-MVFx7Ar801-vjCEB2FGxhpc1J2tam3hkMmLFwXiCv1cXxSOhgyZEqAnwad2RuVzFA_g0jI56iIKfg9ai86QEW8CXYzK-dIus7xLZL4y0y_cjxFhDD0nGfslv15znXkDzjXuGrXZMt0PiKNMjF3eO5zyP4xpb18BsQf1h1XL5ZxKmeTJ-UzsprXRY5U8IohM00M4GI8B6PKxcscdpNhbxudCZUsi5BMkFlqzqfUXad-1NCB1gp8hCYwkt9sSTP2BTGiLGSSW9oDYTbfNP3vpB7Rt8XA6bWDpZUJoAX7ToCdM95_L9A3RNmo8-6BqDaYQ0lEAVlWvv6n7xkBFcJQ'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJfOW0xcEZ0OVoweUhlRW5Tek5WWjJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYxMzNiZTg5LWIwNTgtNGI5OS04NDMwLWNjZDA3YTRiZWY5MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOSwiZXhwIjoxNzUxOTk4NTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGJjNjUyMTItMDM5Zi00MTg2LTg2YmMtODczNWRkYWIwM2Y1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.wZvhqMuq6dDygZk6boiESOgs_4XTN9wL379vyL-Mpw_MIBbJG2_ELZ1q_f6LXqKP5Hp1s2-K3OvDiB2qAYG-CprxGjmX129U8czHzq5hk3YKEk0ynx0NzM0Ogx5wPPZQehki1YcMeHoEtoylEQEB1h8xaQsduzKEEgJTDI-sTPfjcbeHn8G6LghzZA26CgbepWTZfb_taZa_nhS_j-Z2FNN4u3mesQCpo9gTMTPug6EBb5o2MjjXvIPIOVbn-4SOQbTAZlA9oAPq01l_FuN4SOHlYrtvly51XTnDaLkv64qtGpwTEYZMoxBGh8RYhS7MGg5BtO39hpGmvIJUwEfbKQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 990
[ {
"id" : "452c88a1-cd76-4a42-a36f-dd61f78a17bd",
"identityId" : "4c58086d-c18e-4a3b-955e-10706c68a58c",
"standardRoleId" : "aead5f33-e9fb-4fe6-bc3c-39aec77ee8f4",
"createdBy" : "8e49c524-4a78-4fe4-992f-8baa568a74bf",
"createdAt" : "2025-07-08T17:15:29.377035Z",
"updatedAt" : "2025-07-08T17:15:29.377035Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 911baa75-b98c-475a-85bb-a1188e742bf5 to identity 4c58086d-c18e-4a3b-955e-10706c68a58c"
}, {
"id" : "7145062a-a1e3-40fa-8e24-c609693c686f",
"identityId" : "c01e8ab1-fd4e-4671-b40f-f37c406ed8bc",
"standardRoleId" : "275fa782-c551-4d49-b994-c86b6e4f1318",
"createdBy" : "daf1b04c-1b4c-4032-a020-3da41d8c7cfc",
"createdAt" : "2025-07-08T17:15:28.281231Z",
"updatedAt" : "2025-07-08T17:15:28.281231Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 51 Admin - e6d116fc-4e1d-4afd-aff1-d300a827636c to identity c01e8ab1-fd4e-4671-b40f-f37c406ed8bc"
} ]
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/aa3003bc-0d86-4e4b-82d1-71ae95abbb96' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiItV1VaMkk4LVl1WGl3Uk04NmRnZlhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYxNjg2MGYxLTc5NDktNDYyZi04NTAxLWYzMTVmYWIwOWI3MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOSwiZXhwIjoxNzUxOTk4NTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTFjNGZmZDYtNzFlNi00Y2NjLWE3ZjMtMWQwYTg1OWNjNWUwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.P2iHOmE0uXwUI9xDkFuryuFRDsTViRSkicxau2wcHZvOVkt4sFtLyIY9ItSJ2xbmqB0uoyDcBV8qu5OHp5MNBCxt3zrQV59HmDxE54Q0MwXphgUDDDrU6oC608K50w9SR90tnvxX1SE7V6rFkhzZldJ-SI8e8JynpBzZQIr_6_iK9ny_r6DKgBxE1iffSHOS_CPjzW8r7Jnsk9WDHhUmUleSgDBjsImfLhAqt25KjnNKkWjB_cI1VbGOX-Q4S0TqncZ1uBMMQpzo5WlSVfM_AoeHTGuflGWuMWHDqhoX7zhPw7KtlY_DxdAA7rm5_qAs8gmBCpSkQEh_bTof3FecpA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "aa3003bc-0d86-4e4b-82d1-71ae95abbb96",
"identityId" : "185eb0b4-9270-400b-8477-27ae5c674b16",
"standardRoleId" : "be48bd89-4a9a-4293-b07b-4a00a38322fe",
"createdBy" : "b9a7c43a-eb3c-4c2e-96c3-deb8348d3aca",
"createdAt" : "2025-07-08T17:15:29.542184Z",
"updatedAt" : "2025-07-08T17:15:29.542184Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 63 Admin - a1404fbb-974c-4f32-81f8-26bf64d6af2d to identity 185eb0b4-9270-400b-8477-27ae5c674b16"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJ0OWQtMEJpUFBobkhLWmFCamdCc0tRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhlNDljNTI0LTRhNzgtNGZlNC05OTJmLThiYWE1NjhhNzRiZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOSwiZXhwIjoxNzUxOTk4NTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWNkOWU2MjYtZDMyMS00YWM1LWJlMjctNWVlM2ZiZDkwYjk2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fSx7XCJpZFwiOlwiMDk1MjgxNGYtNzk4MC00ZDFjLTg0ZjgtMTA3YzM3NTQzYWFlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.aTBV1Csg-gcQmKkZtGvM5ZlpQN6kMvlOnfV77pjI5_WAiSiz7NjMvfDgeKJoMZONBbltCtgA2u9JPKzqPNCK9sw9d9pQfVnQ8do4eHancCPdVSNOVCuQLHC4hSYdZCsIIWnrWCU_WrJAGqneRn65iuh0qFdg4mbdmAar3w7eNBgDUyVkZAZ1h7q1piOh3Lur7OzldaII6hMow3Nq4a8ceXpallx555tNbO5HINn5jLZj58I2sV2luior4N-PTAzxoL_yTkbQhIul6U_SC1qg-daoHda-wlZzGbfKw3udtcZp7UQy6pZDqBKekgDK4z787Q70H3AqtS3ohP0bw4j-QQ' \
-d '{"standardRoleId":"aead5f33-e9fb-4fe6-bc3c-39aec77ee8f4","identityId":"4c58086d-c18e-4a3b-955e-10706c68a58c"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "452c88a1-cd76-4a42-a36f-dd61f78a17bd",
"identityId" : "4c58086d-c18e-4a3b-955e-10706c68a58c",
"standardRoleId" : "aead5f33-e9fb-4fe6-bc3c-39aec77ee8f4",
"createdBy" : "8e49c524-4a78-4fe4-992f-8baa568a74bf",
"createdAt" : "2025-07-08T17:15:29.377035Z",
"updatedAt" : "2025-07-08T17:15:29.377035Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 911baa75-b98c-475a-85bb-a1188e742bf5 to identity 4c58086d-c18e-4a3b-955e-10706c68a58c"
}
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/6f7db7aa-4f59-4917-beb7-ec56bcc7b419' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJ0VjdLUExJMTRySkNkU0RLXzh5WmRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRjMmI2OGViLTk1YjYtNGU3NS1iZjBjLTA0MjBlODY4YTE0MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOSwiZXhwIjoxNzUxOTk4NTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTU0MDAwMWYtMDEyZS00NzZmLWE3Y2YtOWZlZTczMGNjNzdhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.aJXutIobi6q2xsXYHvjk1XlMMbQsFSaLU0ffTrlvy0BPZO-5t87-ucNsEY1-ZUOSAMOFTd6xp5-siihzXX6gYyj2AfB0pOhul6Oco1Lu0HofIJ4jKZvLyY-QI7D62OxMH2XBD_JKEISROMBUkCW1EGcrgJ113kYLQqq73e38lTpYnTfvupkm7IGJ5MXGeuaD7CUld4wKeYTZbNQYc9eBquYo1L93BxskNOjgBx6_7VcXzLxvXw6U0Cnvhtwq4w399iVGMasocrDFPEsoZBZnWZGOLdQkMA2dDXsV2AODIWARzEgFbqeFgxp7ejMXz1txwXpldata8nfqaBQbelhK-Q'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJGcEFIbXB3Y0FhbTExQXc4SHRUdDRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc1NTk5N2Q1LTkwODctNGI4MC04YzMzLTIwMDNiYzA0NzFjZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOSwiZXhwIjoxNzUxOTk4NTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmMyNWIyMmQtNGNkOC00YjkzLWIyYTUtMGVhNWY1ZGMyYmU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.h2QARa94rHLKNcStMU1U1NOSN1wTlFGIuordye-MvwO6RW_bEWsCPvKrfbrsBFaJ77fqK7-1MJIh4IqzOChF1KrN6RYwahcdO4vpwGz7dhNMYqsI098ZsoDHj_-Gre0iQvuaxN580M5BRjXMXT8zPeFxXMX4pMKdFLCevdIRlgmssT9sVa68kZtYf_R6xQDm-48SrkjeFH8oLmmee4nCIQ5Zrz6WbmUPJ7Z-IKa2LUNtCTvyXRgV5wnP3uxE8FQUC74WpIixSx7LgQE0TFG0fdw3EF5OLrSZSLF1J0ZnSLFBqX2HaNOeJUVaLtqlySBQc-FZp7ISmvW8Sl59th7KxA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1038
[ {
"id" : "f9917783-a470-4037-8a8c-7d64a3946555",
"resourceTypeId" : "793a097f-ab43-450f-8c2e-b76e965bde6d",
"authorizationStrategyName" : "Read-Only",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:49.776176Z",
"updatedAt" : "2025-07-08T17:14:49.776176Z",
"_title" : "Network Group Read-Only"
}, {
"id" : "5fa9bd3d-0791-4bfb-85ee-23b74067d380",
"resourceTypeId" : "28911c43-e3d1-4932-ad93-3d0e6f91614c",
"authorizationStrategyName" : "Read-Only",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:50.810839Z",
"updatedAt" : "2025-07-08T17:14:50.810839Z",
"_title" : "Custom Role Read-Only"
}, {
"id" : "851aad19-9ec7-4273-b66a-624ca7065649",
"resourceTypeId" : "3a156015-9388-45a9-aa0f-ca1037fcc2b8",
"authorizationStrategyName" : "Admin",
"createdBy" : "4681a652-60df-4129-a013-2e0ee0df2c7e",
"createdAt" : "2025-07-08T17:15:29.533225Z",
"updatedAt" : "2025-07-08T17:15:29.533225Z",
"_title" : "Test Type 63 Admin"
} ]
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/c7fe54f1-667d-4917-bc47-f46d526f917a' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJWdTgyb3pra3llR1M4MlNxT3N3eHNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM3ZTA0MWVkLTY1MzMtNGM5OC1hZTI2LWRlYTlkYWUxZjM4NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOSwiZXhwIjoxNzUxOTk4NTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2RlYzE1ZmEtYTNhMS00YmMzLWJlYzItODMzNGI1ZTIxMTRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.oTNuL1RXHWCOwxwt26a-pVFrB5GVK3G1I30t1D3xLfNB9vGA0iQ3JeIbc_SniqO3M7tIWILyiRylxxZjxFRPJa6cJqL7_fTjrTXr1t48vhTyDjIX7cmwl1wXSEy9_SBKaH7v8CcMk38U_XvxtHWlVL52ucerYRwNuxw9oCAlXcnO52pxdKOEHP2aM1PInNPco3UN9xReo_t3SZumn2CBitcOIGvfOVLQHLDBK6EfPb8TJIDNqBMmO2zbRhlOGVEgwxdrcA64dvxm-FDCXmaBWFeUJz1C-wNlSPFwwmlWXFyX9WMPj00VSWapUP1NTqnhm7gsnZ3QUUUvk_dEId0MCQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 338
{
"id" : "c7fe54f1-667d-4917-bc47-f46d526f917a",
"resourceTypeId" : "6855e46c-6f65-4ea2-9f7e-e9953cba4830",
"authorizationStrategyName" : "Admin",
"createdBy" : "f20c80b3-5e11-45c7-aeac-d8abce238f93",
"createdAt" : "2025-07-08T17:15:29.846342Z",
"updatedAt" : "2025-07-08T17:15:29.846342Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJ6WGlhZi1wM0pPbTlncWEzR1Q1UG9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNlZGVkMGY3LWJkODUtNDM1ZS1iZmVjLTJmODRjNWNkNGEzMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyOSwiZXhwIjoxNzUxOTk4NTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImIzOTE0NWE2LTU1MDctNGZiMy04ODM3LTk3OTYyYjYxZDkzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImMxYWYxNWY5LTdiYjEtNDFkZi1hYTY5LTY0N2ZlMWJlMDIxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkyNn0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmQ4NDI2N2EtYzUzMi00NjE3LWI4ODUtZjk2Zjg3ZjhmNmZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fSx7XCJpZFwiOlwiN2ZiMjE0YzUtNTg0OS00OGVhLWE4YjQtYWRhYjExODJjYjZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTI5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.5pyeGJIiaH6ARfEQxuf6BOWOI-MgbG7sTrzISuq2BvFcoymF7nkodNdYQwktBMOHU5iMuEowrzn6mgdyXgYIPl2P_N4l2j0cX2tkgJuGri9mTVjJbhHvLv2emS7jzXE2tPyM-DtqxjmD6fyea8sFbEIcsEJxN3uipacnb_6A46N0SjrparrUzqcDIe-fa3nuENoWKs5PncI13qjC38NR3FVUGO7kudNTjd2wiTSVBZLfbwRbcynvSXCyFDFVKf86C1xfWEXjQpa-4nJyHkOogtQYWOM7S8B9BNi6D6z-qgfT5rnWC5DdncnrXB-pwQrg_9MFQeMtcjNkElHSLMSSVA' \
-d '{"resourceTypeId":"8fe3be68-03fb-40aa-8bfb-857617b5288f","authorizationStrategy":"Admin"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 335
{
"id" : "f3933c7f-8e4b-4e4d-8789-26a0fd1009f1",
"resourceTypeId" : "8fe3be68-03fb-40aa-8bfb-857617b5288f",
"authorizationStrategyName" : "Admin",
"createdBy" : "ceded0f7-bd85-435e-bfec-2f84c5cd4a32",
"createdAt" : "2025-07-08T17:15:29.781645Z",
"updatedAt" : "2025-07-08T17:15:29.781645Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJRcm5yR09jZU0ybmdLODJPbG9oWFFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBhMDdjNTc0LWIxN2EtNDM1MC1hZjM2LWQ2OGM3NWU1MmE2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkxOSwiZXhwIjoxNzUxOTk4NTE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTUyNTBlNmYtNGRiMS00N2ZlLTlhZTYtYzNmYzM2MTVhYTY5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.AMAXO1FZ0lMBHq7r5Fn9sX5hZFycdLigATr-8BM0dQhPd6-NK-LGpDZQWUDGXXVm1QtPy6I2gNzAZ9RzER5MFJAfnOlw3YZBN1ghjrQs9gD3Epfs5i9Ci5kzwjfQmWaRcsf5XFcsY0ryEjlNpl5AmBO-IbE9rw1cBL3k2ObbDTx5lBs5hAKH6ExK5muxCeR9T0L6uU-_vLSXlU7aq2C6KEPm5dABAvrPe_pepOshl6hqa3H3A_zglM2VTGsMuZ2Qh6QVuo5JwVS4J0u8m2a8Z_bi_UHy_N61C5pmf1_Wk2uZXV8vS2qViq-aR-i_7dI1KqU06o_FOysQJpS9dwgP2w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1558
[ {
"id" : "0af96ded-cd77-4a3a-93f4-79eabbe7e81b",
"resourceActionId" : "32f20bbd-f4a6-4ae5-9e49-4ce2e9a40caf",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : false,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:51.712540Z",
"updatedAt" : "2025-07-08T17:14:51.712540Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Delete Workflow Status in Admin Standard Roles"
}, {
"id" : "1009803d-48e9-4d01-b837-9d436a17e1f1",
"resourceActionId" : "281207d1-f172-489c-a865-5f29765d9a8e",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : true,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:49.741959Z",
"updatedAt" : "2025-07-08T17:14:49.741959Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Read Network in Admin Standard Roles"
}, {
"id" : "c384f340-f5e1-40d6-8e13-ebb9a1956e2f",
"resourceActionId" : "63423826-7dd8-4ab7-b75b-51ee74544118",
"authorizationStrategyName" : "Contributor",
"includeWhenAbove" : false,
"includeWhenAt" : false,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-08T17:14:51.801074Z",
"updatedAt" : "2025-07-08T17:14:51.801074Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Update Edge Router in Contributor 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/914ebecd-615b-4cc2-b97a-8e17094ba1c3' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiItdkpURkJHWFhsbzY0Q2x0NDlHaFdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVmOWMxNzdjLTFjNTgtNDM3OS1iZWE0LTkzZjVkZTk5MWU5MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMSwiZXhwIjoxNzUxOTk4NTIxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGE0YzUxNmEtMDRjOS00NDZmLTgwZmQtYWVjMWVjZDEzYjJhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PEVRAuIZMnDTsUspb0Po_S4NEiHUOD6SLdFiRPIoiK91thCTHTJEukzWy_vkuBbl2GjLUUzp8n4TPtL4T-U_yXyJCPEVfgQx7RBt0P6mxQq45RI6Y36DwDjxWhq4JDhdFNk1W2dyhH4SZT7hv97DVT6xNhutLLY_wS_-KW49OTiNyQ6kkRGbSmrZpm4hEKdwOvZ9ylqijLz3paRC8Re9qtEzRYRos6xJyotgvoGPJaMpPIn1k0V45cCeqennkHw_Akz1YnfEsvv2jdCDeqmLXOUW-1uW1rZ8wKoP5euL2yHWh2LMej79YiqADmJxOFU1sFGqrKR6NdAnf5CBPp6YjQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "914ebecd-615b-4cc2-b97a-8e17094ba1c3",
"resourceActionId" : "3742390d-01a5-40c4-923c-f5c19b1bf690",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "50c45181-f231-4182-a63d-36eb5efa9cda",
"createdAt" : "2025-07-08T17:15:21.023924Z",
"updatedAt" : "2025-07-08T17:15:21.023924Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiIyR2tkVWJMdWx1WFEwLWlwVlRSelBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZlOTZlMzFhLTg5MzAtNGYzOC04N2EwLWI0Njk4NzAyYTBjNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMSwiZXhwIjoxNzUxOTk4NTIxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODAyODYzMmItNWJjMS00N2EwLTg0OGYtN2Q4NzJhZWY5MGJkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIxfSx7XCJpZFwiOlwiNzk3OWM3OTktNGY5MC00NWQxLWE3MTgtNzIyNDAyYWJhZjc3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.g7OZAIJ-Qa8C-z6h2CJzQg580fqStND10cPZbxp7CjMpCeWw0UG7kIkIbvjbm3dWlqojU10rMuiimoAF33jWvs5fVtlNoD64AFxXu_HjjQmOmFrrnS1cdPoEFgeezYxNBzIZQdZgMUJKbSXY3it-TVqIUrQ5EXAJr6L-F2LR2GFwIMyr_UCIMjwhdXXOWyWbDEKapiXj8K3EbcCHtFji4swPLeIX5ypIyES51pcEwqtdx9fKkkYTCImWy1kweCg6FO8XsDTp60ioiFeHz8vgKKrfbnjkMqB5ITuSfti1bM3GzG8Bn1MBYdkKyNBeAQSunoVMIgpjacbPaFMXEUSwmw' \
-d '{"resourceActionId":"5add3e16-23db-4713-af37-39cd1db796d6","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 526
[ {
"id" : "d55c9e9c-7102-49c2-a57b-956582c7a46e",
"resourceActionId" : "5add3e16-23db-4713-af37-39cd1db796d6",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "fe96e31a-8930-4f38-87a0-b4698702a0c5",
"createdAt" : "2025-07-08T17:15:21.596687Z",
"updatedAt" : "2025-07-08T17:15:21.596687Z",
"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/eb9ad173-db0f-4668-a0c9-4fb5c40e19bc' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImQ0OWRlZjQ2LTY5MDItNGM3ZC04NTU1LTI3ZTZmMGU0OTgxNSJ9.eyJqdGkiOiJWWU91a2JDc1pJdktJSVBLUWZxY0ZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg0NmI1ZjkzLTNmNzAtNDUxYy1hOTgzLTgyMzZmNTFjNTMzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MTk5NDkyMSwiZXhwIjoxNzUxOTk4NTIxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjIxOWZmOGM0LTI4NWUtNDRlYi1hNDkyLTRjM2JlZDM0ODc1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjI2ZDQzYTE1LTg1NWEtNDFjNi1hMTNiLTU3NWU3MGI2NzY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjJkODNkZDQ0LTY0ZDUtNDFlNC1hMDBjLWE4M2U4MWUyOWE5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjMxNGE3ZTFjLTM2YzktNGYyNC05OTVlLTQxZGUxZTI5M2MxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDkwNX0se1wiaWRcIjpcIjkyYzU5NDZiLWJiMDMtNDllMi05YjBlLWFlOTdhN2I1Y2EwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcIjZlNjQzOWMxLTNlNWYtNGVmNy04ZTMxLThhMDlmMzIzMmYxNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MX0se1wiaWRcIjpcImFmNTA2Y2E1LWM4ZWMtNGM3Yi1hNWU0LWY0ZmVmODEzZmY3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5Mn0se1wiaWRcIjpcIjg1ZmFkYjJiLThmY2QtNDQzNy1iNTNmLWRmMjQ1MjZmMWU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcIjE3MmJhNGQwLTJhMmEtNGE5ZC04ODc4LWE0Y2U3YzMzZDYxOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5MH0se1wiaWRcIjpcImEyMzlkN2YyLTlkOWEtNGRiNC1iM2IzLWFkYzhhOThhYjY4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MTk5NDg5M31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDBkZjZlYWUtMTY1MS00ZTZlLTkwNTQtNThlMjJkYmI4MWJjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUxOTk0OTIxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.6FOFIwNaxLpY-S_LX4tzfI9-SZfvudVvktwo4UNJ_I1u18xIMCh5Pp1O9CxKiJwvwYSn6A35zACw1LUDmU9SMR33gqhc8qxEu3wLKMyf1v7i8_Ju3Lu3TrwdTyX1x-FJerpyNmRxaw49Bw9Xvu9aMuHfPd71mMP3GaQ0U-hAFzzDgl0DfLSVyscGlTZsrL1EAzY8kaML5olLQj6SvE5oNKLVNUzcHz5kGOOdzbJ4fOf4BYrkpA6Wuui7JC_exacJZAG68Tbpz33fyurPkd33hhIohE1IQ1YyTeNYTW5EEirkjTtCHZkaCHTmbIMqpOthM2w8iiIl6ok5wwMwC-15pg'
Example response
HTTP/1.1 200 OK