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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ5VzFvRDg0WEI4NEtuWGdDalFYdzdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA4YWU5NGMxLTJmN2EtNDcyNy1hZGI1LTg0MDQ5MDJjYWZlNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MCwiZXhwIjoxNzUzMTE2NjQwLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjhjNDg1NzczLTMwNjEtNGY0Mi04YjU0LTc0M2Y1YzQ1MjdmNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0MH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNDk1ZTIwOWItMDQxOC00MDI1LTlkN2UtNjJlNDUxMGFmYWEyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiOTMzNjUzMWQtMDdhOS00NTA1LTlmYjMtNjJjOTgxMDZiODZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiZjJkMGM1NmEtNDU1ZS00MDkxLTg1NWUtNmY0MTEwZmYzNWJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEwfSx7XCJpZFwiOlwiNjE1ZjM2NGItNDZlMi00NmZhLWI5YTktYzE4MjM1YjQ2YTYzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDI1fSx7XCJpZFwiOlwiMjc0YTEyN2QtODQ5Yi00ZDBhLWE0MGYtYjViNTBkM2NiM2ZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiYzljYzYyYjQtOGExYy00ZWRlLWExMDUtYjQ1NDFhYzk1YThjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEyfSx7XCJpZFwiOlwiMTNhZDczMzUtOWQ3NC00ZjMzLTg0MGEtMzc0MjRmY2VjMDFjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiZmYwOTIyZWEtYWYwMS00OTkzLWI0N2MtNjU1ZDgyNWMwYmQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEzfSx7XCJpZFwiOlwiMDA4YzVhNjgtYTE1NC00NjI4LTkwNzgtN2I2MWM4NGVlNjVhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEyfSx7XCJpZFwiOlwiZDZkODdiMWEtMDk1YS00ZDAzLTllMjktZmQzYTgyODMzNDg0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEwfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.qtLyX0-bYemjilu4eQBofJFHWdyl5fJ-xteKPlQpTjPNaZq2QHjFai-p1Ckjig_sg5wIPiYoxscoP-3RvGU9Dl553I-OxNXNmD4dKEnLLOOYt_ODDzrOoRQJV4UiPVWb7z7t-5OlTfHCuKgWY-rnUeeZJJRrV4eGfSJk_DRyzPuFEigdExlCt8Y8SFiRGND5qbVFt5aLKr-uvLpvo_RKbauBifxFmn8qh-05NBRp11yNdtOHDUg90FDIQoScD0xAb0LC7Ojjpkh0lfrkJwavN3FfMNzAK06vgEpIGBmO6YDuh5-aGshG8dIf06tKEyG_xCeKGbIpmPLiJF1c6HKQ1A' \
-d '{"identityId":"0605837c-e0f9-452a-a644-2c27cc03c52e","audience":"io.netfoundry.test","claims":{}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1950
{
"token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiI3Qkd5aXd0UTQ1M2xONlFoNHpLbFVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA2MDU4MzdjLWUwZjktNDUyYS1hNjQ0LTJjMjdjYzAzYzUyZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTc1MzExMzA0MSwiZXhwIjoxNzUzMTEzMzQxLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImMxYjEwNDE4LTU3YmEtNGUyZS05ODA1LTU2NDk1NzAxMGZlY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNDk1ZTIwOWItMDQxOC00MDI1LTlkN2UtNjJlNDUxMGFmYWEyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiOTMzNjUzMWQtMDdhOS00NTA1LTlmYjMtNjJjOTgxMDZiODZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiZjJkMGM1NmEtNDU1ZS00MDkxLTg1NWUtNmY0MTEwZmYzNWJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEwfSx7XCJpZFwiOlwiNjE1ZjM2NGItNDZlMi00NmZhLWI5YTktYzE4MjM1YjQ2YTYzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDI1fSx7XCJpZFwiOlwiMjc0YTEyN2QtODQ5Yi00ZDBhLWE0MGYtYjViNTBkM2NiM2ZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiYzljYzYyYjQtOGExYy00ZWRlLWExMDUtYjQ1NDFhYzk1YThjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEyfSx7XCJpZFwiOlwiMTNhZDczMzUtOWQ3NC00ZjMzLTg0MGEtMzc0MjRmY2VjMDFjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiZmYwOTIyZWEtYWYwMS00OTkzLWI0N2MtNjU1ZDgyNWMwYmQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEzfSx7XCJpZFwiOlwiMDA4YzVhNjgtYTE1NC00NjI4LTkwNzgtN2I2MWM4NGVlNjVhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEyfSx7XCJpZFwiOlwiZDZkODdiMWEtMDk1YS00ZDAzLTllMjktZmQzYTgyODMzNDg0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEwfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.hfL-oZ1HqsZY_hjwPFi-Rf2cXbXCImMsdZGcuKyDKuOF0cJyPz_V-91jiASdP3F7QYnHzp8SkBjLOOB28H3SOaI98QqSMYajl-pDbvqvwh-wSbdSfW09DxUPR2aFeEOLCiYvM2B7pw5ujD6pzz1YvsoG2St66wOOQ0t5utJn5S9zR9qw87Yg7G0lqJ8Vhn5NwIo1yD40V9hMJb9bKh3KtPwQFIye3ffgQ1GyO9jN-GXtPZOQL6tLvHTmVmFy9BLIp6hizeerhyUW5Etk6A4SBk6-vyODSQyk6eoibqgc0X2-RpzyDeuU8WfiXat_NDhOO_WYTbcOdaBRfcusEFRkmA"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJsUXlfVjEtVVhKTS1MQUdSSnNlaXNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNmM2U0OGY3LTc5MWQtNGVkYi05ZDlkLWZiY2UzYzE2ZTMyYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2FmZDZhYzQtN2ZmMC00YTQ2LWEyNWEtYjgyOGNkNjIxMmMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Z7m9hsCA4Vf308JNHt9IRHy346yxhiSd-txLSTdn0o2gTRo1sKILlTbG2DqDJ5MN79tbzgqjpOTLKBIJ90K6R28EvK5RFzxiFqqQcgaXhar9ZVOraplPCsacYUFdycyeJh739uOj8Fbsq5cmYb2NtafUBDru9tnbHIlGE3_2MltR1Z5lb_QwtAfBhCUKnKxJc_4_uhZV9DOh_z4EwV3zvZnG6uy9Najcj-TRLisoe7152CKZYVxguX8PwvTmMwAamHqJDDRHNFq4oUjNDZiKJME2K6k3Iwd43fw8x6jAEQss7YchsVJIM2_miXtCNRUrKXSm1frsCvpSowSm-eyPZA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 904
[ {
"id" : "8787f5e2-05e8-46a8-b559-20b7059dbf3b",
"name" : "Test Domain 1",
"code" : "test.domain.1",
"createdBy" : "581a3d30-0113-4be5-ad84-bfbd71a62af2",
"createdAt" : "2025-07-21T15:50:30.245820Z",
"updatedAt" : "2025-07-21T15:50:30.245820Z",
"_title" : "Test Domain 1"
}, {
"id" : "696f02b5-03ec-4608-a72d-c1b9cd6980b9",
"name" : "Organizations and Identities",
"code" : "io.netfoundry.identity",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:10.201112Z",
"updatedAt" : "2025-07-21T15:50:10.201112Z",
"_title" : "Organizations and Identities"
}, {
"id" : "b67a42c9-85a0-40a5-b8cf-81bcf902340c",
"name" : "Billing",
"code" : "io.netfoundry.billing",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:13.275252Z",
"updatedAt" : "2025-07-21T15:50:13.275252Z",
"_title" : "Billing"
} ]
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/a4849913-a32e-4f2d-96f2-726db1164874' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJjcEUySW9fV2hZN1dlSHN6djRBcVJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImExYjg1YTUxLTBjMDUtNGM5NS04NWFmLTc3MjE0MDQ5MDZhMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGFiYzQxODAtZWUyYS00NTljLTk3NjQtYzU2Nzk2YzNhZjgyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.pqL3XpdfckprJ-iZcdiF5MnwUGPC3EGbPIJwD71BVOIgORfDwOdHK_R1uskzJT2CdIPbYvQk_NjINsa6hypwzy_H7LLZ3CQDUhxkYuv8jtK4A2J-cEyzPNbOuqDswdmFrYYkJO4Z7BV-FyT0_azb0XTAgKz-J6XhkM_Nptbuf1ZZniYdxqv3-lBA3ddiisFT8_i2tIhDbvMtlXzPLb_uq_rOMncV9awgYNzRkaQrvkV2qbboXjJVIg_pWMJUFMebW1kvmSVQVgDhlinMfZLY9gDKA05eIUcvyp9loiGkK65pY_RZluMwKptX4Kpq5XFoeZSYeRHMxkgf4JUVX7DEBA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 288
{
"id" : "a4849913-a32e-4f2d-96f2-726db1164874",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "ec626e9d-9830-4ed7-ada6-499e83c8ec2c",
"createdAt" : "2025-07-21T15:50:25.691584Z",
"updatedAt" : "2025-07-21T15:50:25.691584Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiIzTUNiNmQyX2N2VTJDTE9rMVQyM0d3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMyNWY1OTg2LTY1MWMtNDljMC05NmNkLTYyOGIwZWNlMzY1MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGRiNjEyZmEtYjRiOS00ZmZlLTk2YTMtOGM3ZWFmNTRhNmZiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.p3LMgos-n5nQiiGSPqPvqhI3gwqgvr9OZLtRnXTRAK29qKnSVK3H8IhOgFgBW5rdzteLIcd5k6WfAZgLKDWjDKfg2_vPCluAjMKRahVYnZPIUDMJw89qcBzIdduULlI_zqyUhL0KpQgeS_ymqe_r3dB4rWQdpiU_AfOPqSFMcLk-C-piY-KasSm1P_is0CulsKLCxQqU5jUYM0SdjVLIVP_7G1TPLAqK_o8SlCmZw7PHa_5RK4tgsLQCaHaS8Ok2iDRibl_qf_z-D5qO5WSXWu9eMq4Jva6Y-RGI354MsBaDfGNHvyhz0A10CccHJ77EXmltYwcmI4OHXECtFq3OwA'
Example response
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 288
{
"id" : "a4849913-a32e-4f2d-96f2-726db1164874",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "ec626e9d-9830-4ed7-ada6-499e83c8ec2c",
"createdAt" : "2025-07-21T15:50:25.691584Z",
"updatedAt" : "2025-07-21T15:50:25.691584Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJUY3UxU3dTbllyZENKVl8yZXg0X0NnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRmYzVkNjhjLWM4MzItNGE5NC05YmI1LWFlZWVmZGVlMWFkOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGI4ZTk4NjItZTlmNS00NjI2LWIzNDUtYWFhNWNhZmEyNTY5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.y4PIO3XsvbV6DscBJso22BSJJd0H2q7eob9i0xR0hYrvI9p7OBs2burrUtRRO9RVpIvzW0s34GJRQzlX4Yhbu0j-tBLQmAU3H3ZVCtHsbh4XfJjw6tJiP0ffKeId1YVAErUK6_YaPB6mo1QX0htBVa5IdGI_SMBy0Ffy8bt8H5hvwMSaerqiSwPhHqOevfzx7ubhbNwqLMdsyXZvQclaDx7pP73x4CiEVlg-kjZZwvXwLt4n8FSQa5o3iULeyx3ts5LIGb1apeIoVZv2LMFTkdnFLMfexQIOfaTBkfJvIQZSTI8XQ63K1p5DtHszXEa5p3ekK0_keGkGXjfDKxLDqw' \
-d '{"name":"Other Test Domain","code":"other.test.domain"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 299
{
"id" : "4445b8f3-38f6-41e4-a52d-81f28dae1850",
"name" : "Other Test Domain",
"code" : "other.test.domain",
"createdBy" : "4fc5d68c-c832-4a94-9bb5-aeeefdee1ad9",
"createdAt" : "2025-07-21T15:50:43.929648Z",
"updatedAt" : "2025-07-21T15:50:43.929648Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJxcm5vb3F3SEZYcU51VUREWXJUOW1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIyYmU3YmExLTVhNmMtNDNiNi1hYTc1LTljZWI5YmJjMzMyMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NSwiZXhwIjoxNzUzMTE2NjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjI2ZjM2N2YtMTA2MS00NDE4LTg4NDEtNjc2MWMyNWQzMjIzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.HfuFaJyygur9Ri4KDW-OZkvHfYtS3z9jPRLrplyTZraA7e7EKEqN6MAC3PzJBqqNjm1EpThfjx2Mvf737pDygnw3jXwqcp2wQgyo7jswmkP_eeyiJTmaKoJULKkg8eP8JsWMhDBRlTyBMAKmTyhoZYE09gLo54UMck4E0OyqkVn6ZvKwgNtSvfGY0b8aY_2Ip31SGxlBD-33oBbH3cnWtfkkpO8BuTL5jrNRWaBFOoDIVEBBclz1sunsIdDO3DCVkk_vcARKYwhh14UzdpAt9CbJc--2a53KC6MqjOT7ESjgG6otSkO4O751WJgpTS49X5Id6-N8WhM82Zmmcf8PsQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1341
[ {
"id" : "3a3dc354-8c8b-437f-bb6d-35832f7bf505",
"domainId" : "8eaf815b-650c-44f7-bb25-ca787e95b46d",
"name" : "Test Type 6",
"code" : "Test-Type-6",
"createdBy" : "215a1160-501f-4ad2-b7a1-4e0caa982d9e",
"createdAt" : "2025-07-21T15:50:30.388437Z",
"updatedAt" : "2025-07-21T15:50:30.388437Z",
"parentId" : null,
"root" : true,
"depth" : 0,
"childrenIds" : [ ],
"_title" : "Test Type 6"
}, {
"id" : "cfaa2da6-9dce-442a-84e1-6b7dbf3e4c5a",
"domainId" : "055387de-b54a-423d-8f8c-340a5110364c",
"name" : "Endpoint",
"code" : "endpoint",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:10.289400Z",
"updatedAt" : "2025-07-21T15:50:10.289400Z",
"parentId" : "64ed7875-7aa2-4fd6-b1f7-dc1e0d49a086",
"root" : false,
"depth" : 2,
"childrenIds" : [ ],
"_title" : "Endpoint"
}, {
"id" : "205b17ee-422e-4135-a33c-6abe0e02008e",
"domainId" : "b67a42c9-85a0-40a5-b8cf-81bcf902340c",
"name" : "Enterprise Subscription",
"code" : "enterprise-subscription",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:13.276122Z",
"updatedAt" : "2025-07-21T15:50:13.276122Z",
"parentId" : "2529bc81-9c74-4b77-9f56-33386216b3dd",
"root" : false,
"depth" : 1,
"childrenIds" : [ ],
"_title" : "Enterprise Subscription"
} ]
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/8719bb60-6e71-414e-9b25-62a96c6e13f0' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJrWkxGNzZrdTlsT3BKZFRiX2dSc3hRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFkZTM0NGZhLWE5NzUtNDc2ZS1iN2EzLWJkMTg2MDBkZjM3YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NiwiZXhwIjoxNzUzMTE2NjQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2JiZjA5NGMtMmJjZi00ZWQyLTg4ODAtNDc4OTM4OGI4MDZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DDrGDH9gDFYH_vzaZHlkefQ4bytrw_b1BkODP9L594RHo2_3G25dVEM_Zj6xaE87pvvVI6BLbQXX1C1mzZZkeNS1D3ZzWXJDiBJIG-pRYEl2nTqWoHVz0Xbfnn0ifYsn9MiNISy51cSblFvRvqlNsVCBnLddn08S2HgELDYZtHrn-wYwF5_ZhqQLvgKNAZHj0we8TRwTuq5nW8-5sI4aupA0haxTjpZ89gfRU5n3S5KNfHA3EG4Ae78rkBZm5UdPoVQZNteESirRcUKghRQE8lXzVEiU3FAHi3_TJyjI9Moz_NXWBLf-l6vjPfWfWcKS867Pde4zmdqQQxkBXZIaXQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 406
{
"id" : "8719bb60-6e71-414e-9b25-62a96c6e13f0",
"domainId" : "a4849913-a32e-4f2d-96f2-726db1164874",
"name" : "Test Type",
"code" : "test-type",
"createdBy" : "868e5756-6015-4260-a77d-b7277e74e5e7",
"createdAt" : "2025-07-21T15:50:25.789875Z",
"updatedAt" : "2025-07-21T15:50:25.789875Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ1UDFWU2N5UDB6U0VuRjNtNkdHejh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZiMGU2YjIxLTRiOTQtNGQyOS1iMmFiLTJlN2E1NWZiMzkyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NiwiZXhwIjoxNzUzMTE2NjQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzNlMDAxY2ItNWE1Mi00MTU4LTk4MzMtODQzOTlhZjE5ZjA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fSx7XCJpZFwiOlwiYmUzOTVmODctYTFjNC00MGNhLTg2ZTUtMTNjZWI2NTgwMzgzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fSx7XCJpZFwiOlwiZDU0ZDQ2MmItMjU0MS00NGY4LTk0NGMtZmI2OWNiZjc0YzM2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.s8761Z1InnWWF9ZuxJeI6NJE400TS_RcM1goE-wIMSWz5iaev4bdpSZF8jGb4bGz3T9KrackdzA-hOHDs-ksivFKu2Jcjo-PTHXix1G3IQL44ybXacrFwKNjJWp-2M2fcvecp4nhYvook711WJt4ekrOWbTr6cYflDUfAfCMCbV7wNJtOCtn8xzrCBCAoApg-twrYFDUqa0-vVOqq9gb5zoqKq9WT_rq72Qn1VJy2fDYKDW3y-fSYQz9Ql-LCZD9qIpodF346zx_u0Vg4r1W5rZ5jg5gyeDw7b9mSY-MCvLkSymFHS9g551p4CrPIsbd729_Dirsesc2owZEq2QmHA' \
-d '{"domainId":"a4849913-a32e-4f2d-96f2-726db1164874","parentId":"8719bb60-6e71-414e-9b25-62a96c6e13f0","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" : "9ac02aec-d880-4d5f-9128-2e6bbebd2f05",
"domainId" : "a4849913-a32e-4f2d-96f2-726db1164874",
"name" : "Another Test Type",
"code" : "anoter-test-type",
"createdBy" : "6b0e6b21-4b94-4d29-b2ab-2e7a55fb3920",
"createdAt" : "2025-07-21T15:50:46.272937Z",
"updatedAt" : "2025-07-21T15:50:46.272937Z",
"parentId" : "8719bb60-6e71-414e-9b25-62a96c6e13f0",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ6dmdlRDVlaFlIcmRBSkNNOTY4VGd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU5YjA3OWJmLWZiYzQtNDNiNS1iMTM0LTkzMWJhY2U2Y2Y4YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NSwiZXhwIjoxNzUzMTE2NjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjYzZDY4YzAtMTlkNS00MTA3LTkzODctYmQxNmUyZmY1NTUwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZrpGxXfeD9FSN4lWL3qIP-Ij1erPFHyHNByQXJce5S6mdgKuc4yc3WZx9POS5RKRJDH5jTZ7KAB8WEf-QHaLMfs3aFO6SBvfTQb5grHS5nv-XBvJiD9SumUpfnSwffnh8wleWzKqOxvmyN0tc1R5GDdhBSw4ati_XcwLUQkHGmOT7Y7MhspLRvAlkQQA1rPrxEvpAIZs6usTNUFcn4avqDa6axzBSAT2OV5J1Q5jKJhdrMv4SrqJJcC7ChxSVtZHX_ExgD_N0XrOjchcE3x1CV9XVY4Wl4pZWnc8H8jgRk_7wXcID7mELiuSXM7W1RhDQC3ce1li0JERFHqaZPd4yg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1096
[ {
"id" : "d807a5db-2f58-4294-a5e9-faa322da38c3",
"resourceTypeId" : "293d69b0-ee4d-4b44-924d-5a514e55b999",
"name" : "Delete",
"code" : "delete",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:10.811922Z",
"updatedAt" : "2025-07-21T15:50:10.811922Z",
"standardAction" : true,
"_title" : "Delete Service Group"
}, {
"id" : "2e6c1874-6bbe-4890-82f0-b0cdb2efadea",
"resourceTypeId" : "d09489c4-749e-4cc9-b535-578431fad00b",
"name" : "Create",
"code" : "create",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:10.297962Z",
"updatedAt" : "2025-07-21T15:50:10.297962Z",
"standardAction" : true,
"_title" : "Create Service"
}, {
"id" : "73baa78c-c9b9-4bdf-9900-9b6097c276b4",
"resourceTypeId" : "c5519b17-e4df-492d-9e90-0674b292b19b",
"name" : "Read",
"code" : "read",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:14.675659Z",
"updatedAt" : "2025-07-21T15:50:14.675659Z",
"standardAction" : true,
"_title" : "Read Frontdoor"
} ]
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/50b6014f-12a5-4ead-9aa1-dee54918aac4' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJtcW95NGp1b2t2WURlamlRVzhvTWF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEwMzllOTQyLTI1NTItNDIzNi05M2YyLWZiZWZkZjUzY2FiZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NSwiZXhwIjoxNzUzMTE2NjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzBjN2I0YTMtNTY2NC00YTYxLWIxZjctYWYyZDY1ZjNhYjVmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.OL0JkOOKbmXNKD-H0eBC5L38FsWfTsy1gaYni9I4a7K8TP4fg4so33cBS19wo7tgg2K8wIshF3q4R0pnNEvk4D4XZUpRj9lGsMJISQPcNGWDJjv8r0hIbC8d0ML0Za2dFHYBYEB1FHshacJzuQTildyqTC9ME3AvvZgS73L9Kd5DFWjtmFysMrWK6PVISJ90MWLTr8KBbY72GU_QMWodefNKCsBtSiaXiwrIRbA9iH4nhYNfbH4VSvCnLF2ZP8qEFc7ha8X6obsLc3duvlErlvQar21Rl4J8WUxCn2sAeQVu3wPnQ9thNRx8wuH671wdZ_mCBFrxaDILrU1DnItM1w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "50b6014f-12a5-4ead-9aa1-dee54918aac4",
"resourceTypeId" : "8719bb60-6e71-414e-9b25-62a96c6e13f0",
"name" : "Test Action",
"code" : "test-action",
"createdBy" : "19bab27c-539d-4e65-ac84-7fe7df20e753",
"createdAt" : "2025-07-21T15:50:25.853051Z",
"updatedAt" : "2025-07-21T15:50:25.853051Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJIakZFZkJjZF9FVk5jYUZnT0c0RTl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYzZmMzYTYxLWM1N2QtNGIzZi04ZjllLWYwMWUxMmQyMGYwYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NSwiZXhwIjoxNzUzMTE2NjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjdlYWU2ZTEtZTE0MC00MTAzLWFhNGUtZmRhZTZiNGI2YTFmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fSx7XCJpZFwiOlwiZGUzMjhmODItMTFlNS00YjI0LTlhMDEtNjViOTIyODUwMDU0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.aHsFbztwBeXciC6GHf5hzZc7Q8loP0f2qw2sEmg9Sjtoa8UeI1RCfgyEbsDHlG29rYQnPAc8_BqTZz6eCAjYI2l1ESSq_VbJOcjyW0Y5qB6DmBCid8_6ziEHD9K23joMcCFLTbO9HAaxsudQRMAywwT-cbys_1A_OUCcSgqoIzeLrQGDYRQXLC81S6EFdij24kRCVOz0TZr5POYqK2-XU8McaZcondh5y4vkapoLrgAX0m2Ii0-4_luCk-qP0URexhtpjNCAmSSc_FR9y0kEGLRGMr-jXC_HkP0zfW1g6-q3kWGd6N7j_SqK53EuwudDRb7qY4yE393c4pfSQgSX3g' \
-d '{"resourceTypeId":"8719bb60-6e71-414e-9b25-62a96c6e13f0","actions":[{"name":"Update Custom","code":"update-custom"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390
[ {
"id" : "9f5a25bd-f5bf-4bbf-8974-200f2394b175",
"resourceTypeId" : "8719bb60-6e71-414e-9b25-62a96c6e13f0",
"name" : "Update Custom",
"code" : "update-custom",
"createdBy" : "f3fc3a61-c57d-4b3f-8f9e-f01e12d20f0c",
"createdAt" : "2025-07-21T15:50:45.524211Z",
"updatedAt" : "2025-07-21T15:50:45.524211Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJkZUZ4NGxPdkJ1VVExMy1hN2xkTWRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMzMjQ0NmFiLTAxZWEtNGMyZS1iZTA1LTc4YmUzNjNjN2Q3NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImM1NmYwZWIxLTE0NjgtNDM3Ni05MjcxLWZkOGJmZTU5M2Y3Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0M31dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNDk1ZTIwOWItMDQxOC00MDI1LTlkN2UtNjJlNDUxMGFmYWEyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiOTMzNjUzMWQtMDdhOS00NTA1LTlmYjMtNjJjOTgxMDZiODZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiZjJkMGM1NmEtNDU1ZS00MDkxLTg1NWUtNmY0MTEwZmYzNWJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEwfSx7XCJpZFwiOlwiNjE1ZjM2NGItNDZlMi00NmZhLWI5YTktYzE4MjM1YjQ2YTYzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDI1fSx7XCJpZFwiOlwiMjc0YTEyN2QtODQ5Yi00ZDBhLWE0MGYtYjViNTBkM2NiM2ZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiYzljYzYyYjQtOGExYy00ZWRlLWExMDUtYjQ1NDFhYzk1YThjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEyfSx7XCJpZFwiOlwiMTNhZDczMzUtOWQ3NC00ZjMzLTg0MGEtMzc0MjRmY2VjMDFjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDExfSx7XCJpZFwiOlwiZmYwOTIyZWEtYWYwMS00OTkzLWI0N2MtNjU1ZDgyNWMwYmQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEzfSx7XCJpZFwiOlwiMDA4YzVhNjgtYTE1NC00NjI4LTkwNzgtN2I2MWM4NGVlNjVhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEyfSx7XCJpZFwiOlwiZDZkODdiMWEtMDk1YS00ZDAzLTllMjktZmQzYTgyODMzNDg0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDEwfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.uzQp_jTxdomY_7GrktVd5RUx5Tw5QSf2L524tN0q-4jfcpke2AJ0L0Ix1ycS-ycagjVYTCKDtzJ5QDS2NK6wVoe9xflvBZK2KKhXvqrwLNewRcqP5pcC9dHDPndfcqB25oLAE7uxyyNYf4qjwivD9960o9t3JSZuhRWxXdF3MEbtZ7oguCtACy8GaHd2DPmSspP2vgDV7xu8hObOsXoP0KD8TPDtZ46FI5NexaCXsM-8eE7I1iqGnB2CrcL_zmdZbTmlkAmwYFWoyCrRKru7SMvGKGIapqoB7yEPy-l-0SlpBWKSnzsgGHgYInERaQhB2hoIBxEBEqXbEo00M9qYOw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2489
[ {
"grantType" : "IdentityResourceAction",
"grantId" : "fb23c579-de05-4b34-ba65-1494acf42110",
"privilegeSourceId" : "fb23c579-de05-4b34-ba65-1494acf42110",
"identityId" : "a17fffad-b448-4fc0-8e16-60baadc1d5ee",
"privileges" : {
"io.netfoundry.network" : {
"endpoint-group" : {
"create" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:10.970975Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Create Endpoint Group, All to identity a17fffad-b448-4fc0-8e16-60baadc1d5ee"
}, {
"grantType" : "CustomRole",
"grantId" : "89aa13d8-4fe0-4022-aeec-3421f5b2b21e",
"privilegeSourceId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"identityId" : "3bab810d-0f7c-4214-98e6-5299c8fc64dd",
"privileges" : {
"io.netfoundry.auth" : {
"custom-role-grant" : {
"read" : [ [ ] ]
},
"public-grant" : {
"read" : [ [ ] ]
},
"identity-resource-action" : {
"read" : [ [ ] ]
},
"standard-role-type" : {
"read" : [ [ ] ]
},
"domain" : {
"read" : [ [ ] ]
},
"custom-role" : {
"read" : [ [ ] ]
},
"resource-type" : {
"read" : [ [ ] ]
},
"custom-role-action" : {
"read" : [ [ ] ]
},
"super-user" : {
"read" : [ [ ] ]
},
"standard-role-grant" : {
"read" : [ [ ] ]
},
"action-inclusion" : {
"read" : [ [ ] ]
},
"resource-action" : {
"read" : [ [ ] ]
},
"standard-role" : {
"read" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:11.271827Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 3bab810d-0f7c-4214-98e6-5299c8fc64dd"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "c7f1a4c3-be71-427a-8936-ad9cce8bab3b",
"privilegeSourceId" : "c7f1a4c3-be71-427a-8936-ad9cce8bab3b",
"identityId" : "0ed768fa-7214-4404-8335-a715156dff45",
"privileges" : {
"io.netfoundry.network" : {
"network" : {
"read" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:12.567802Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read Network, All to identity 0ed768fa-7214-4404-8335-a715156dff45"
} ]
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiI0NnFmRTRSVjA1Q01HbTcwbkZYQ2xnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjViYWNjNDY0LTY3YzEtNGQ4NC05NmVjLWVlMWQ0ZDZjNjUwOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0OCwiZXhwIjoxNzUzMTE2NjQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTYxYzViY2QtZjUwOC00NTc2LThmZmYtYzk1MWQyZDExMWE2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.tKw7p23WAq940UBhQ3xgiN3nvQz-ovx3xOSgpWZveOA5GwdPhJhUoVorVKtvFb9xbwgf6YCWUr1_5Wls1CQsAxhPzuxCawA3wGpCl9CJs61iSl_eU-5LUiNqCeNoR21b8NZMWSDjxzmiR_U0iOdc9MsN-LDgD66D3-xI6_AG_YKjTdrl2UaqbcUHYEvuveBpz1vl-8BY-jXon7hb3k0367oPWG8Qgz4kqJR8Q_3g_aFbcj_S21MRIm7apHNVBMVQIhbq6apVPVj7D2ZQZB71R1SIf-hcfxYguFU5x5f8yRfGwhJl0hyysbRkQI2wOFi9pABID06FUctDjpwou0dCWw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1506
[ {
"id" : "6d5fd95f-3dc2-4bb1-bfb2-1f1d46f15bd8",
"identityId" : "0605837c-e0f9-452a-a644-2c27cc03c52e",
"domainId" : null,
"createdBy" : "05edd847-29ff-40f0-90e4-334745ca87bc",
"createdAt" : "2025-07-21T15:50:48.276549Z",
"updatedAt" : "2025-07-21T15:50:48.276549Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 0605837c-e0f9-452a-a644-2c27cc03c52e"
}, {
"id" : "c1b10418-57ba-4e2e-9805-564957010fec",
"identityId" : "0605837c-e0f9-452a-a644-2c27cc03c52e",
"domainId" : "a4849913-a32e-4f2d-96f2-726db1164874",
"createdBy" : "75aaab71-ed5f-4d8c-9a41-eb417b357360",
"createdAt" : "2025-07-21T15:50:25.877451Z",
"updatedAt" : "2025-07-21T15:50:25.877451Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity 0605837c-e0f9-452a-a644-2c27cc03c52e"
}, {
"id" : "c56f0eb1-1468-4376-9271-fd8bfe593f7c",
"identityId" : "332446ab-01ea-4c2e-be05-78be363c7d74",
"domainId" : null,
"createdBy" : "76d7c480-ebd6-4013-85cb-6d773b59ab95",
"createdAt" : "2025-07-21T15:50:43.995325Z",
"updatedAt" : "2025-07-21T15:50:43.995325Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 332446ab-01ea-4c2e-be05-78be363c7d74"
} ]
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/c1b10418-57ba-4e2e-9805-564957010fec' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJZNzNlcFR5ZHJjY01LX01LVjV4alNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRjNWFlMWU5LTRiMWYtNDQwNi1iNmQ0LTM1MDE3ZTNjYzYxNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0OCwiZXhwIjoxNzUzMTE2NjQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjEyNjY0YTItZGIyZS00ZDFjLWFmNmQtN2ZkNjI4MTMzOGRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DvrCWHzsMVR_Dfk9BN9RUUPV-pIV2kVb82UNn-6w-zQJt6NUjLL03fi1AMxtHpNTfK762HkFouAftRMdbB62Ak6VxABkMMMfQVXS8EsI0QCYutuwCeLDqO5DoavjUnrMkYfCEWiudiWQK6kNRQT8K20csqVLWpg9Npb6GhD6Bf9QPbMOtKDzfLcn2TADb32PNxels1DVXgWAtlyFH2xgnqciicVCrr6I-M_sM5VafwHwk_6zQ39MIz3N7ApLRfMC27A0FZmGzW9RfqwzKlzd0sEVePwlbRR_WBPSbXDfz400fznxyL_XraeeMge_svYh0uYUbSGzxOFSXDigW_AqlQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "c1b10418-57ba-4e2e-9805-564957010fec",
"identityId" : "0605837c-e0f9-452a-a644-2c27cc03c52e",
"domainId" : "a4849913-a32e-4f2d-96f2-726db1164874",
"createdBy" : "75aaab71-ed5f-4d8c-9a41-eb417b357360",
"createdAt" : "2025-07-21T15:50:25.877451Z",
"updatedAt" : "2025-07-21T15:50:25.877451Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity 0605837c-e0f9-452a-a644-2c27cc03c52e"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ2MFNSTzZWcjR2SlNlM3NkQ082N1BnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA1ZWRkODQ3LTI5ZmYtNDBmMC05MGU0LTMzNDc0NWNhODdiYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0OCwiZXhwIjoxNzUzMTE2NjQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjdiZDBhZDktZDgwNi00OTg1LWFmNzYtNTNjNjNjMjBkZDQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ4fSx7XCJpZFwiOlwiOGY4YWM5NGYtMDRjOC00NjdmLTgzZjAtZWQ5MGI0MGE1M2M2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.utJFD2DbMD-R5wLZfFJHv5on_jOvYRV3JH0f1aZDCFVWyqt727FgrCJC7W8dp9FAjUblrP4bYExNwdkjsZUbKWfmtapSf_1PNOpfpekqj1zc4TvHUXxgfzTibTMcSSFK-qPfIYB7UnLZcYMserClNfgCXRzWBSFq07mfMtm1V79gYczN3jX2ooHk4BH_ab0ntNX7pI57XtxRk2G9omQ6kcNvdXhUjY5KN8019MJzn9hOGS_OGiGW66vveTMaDP5S_2vKvOkx_x4iOjaOP-pudQ7B_-GrQo2tg074oK-zmXxQUiOgq2FkPOdorxX12HUm1cBPWy_CY8r-P-AiTO7uxg' \
-d '{"identityId":"0605837c-e0f9-452a-a644-2c27cc03c52e","domainId":null}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 488
{
"id" : "6d5fd95f-3dc2-4bb1-bfb2-1f1d46f15bd8",
"identityId" : "0605837c-e0f9-452a-a644-2c27cc03c52e",
"domainId" : null,
"createdBy" : "05edd847-29ff-40f0-90e4-334745ca87bc",
"createdAt" : "2025-07-21T15:50:48.276549Z",
"updatedAt" : "2025-07-21T15:50:48.276549Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 0605837c-e0f9-452a-a644-2c27cc03c52e"
}
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/07f606b2-2528-4727-8409-6137db0a5291' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiI2VEVPMmlmdnFYRmN0RWluc3d3M0tnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg5OWUzYThmLTMwMWUtNDVjNi1hMDRkLTMwMGMxMmY4ZDA1MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0OCwiZXhwIjoxNzUzMTE2NjQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGQwMTBlZDMtNDFhZi00YmFjLThhZTItZWNmMDc5YmQ2OTcwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.WpKzquF8VBYsHdcqjswVKkgIGeFYTQlKzWiZDYEE0I3W8kRAoiH5p-wzIm6o_wIQXy4PY5_9-UT-fqZA4shUwroXXW9EovcmJQaITiZJ9PI_efaLE127y_qqCRSmavx4PUqMflE9924WxHv7D58O5_mj7q9tVkl9yPzJNp1_ubzIYDjB4Lthj6jdGyAV0RMWGpk9T-vK0G2gjJiR4udVE_fg7IR4Fngn3UXRfstYOS9BdCJZr2NdujwbuLxNQmeOQiqdJUgXNGqr0LlzHN80o0J8qsybiWhA-581igolRwtDVuR12BQJG2JfMK7Y6-yOzQjyBuxHq5HSgQSfSTxpNA'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJudTBrUXVqVDlIdnJqNVVmaktuMEFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE5ODNhYTZmLTdhOWEtNDkzNi04N2ZkLTA1NDJiOGQzNGEyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NSwiZXhwIjoxNzUzMTE2NjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2JkZjYyYWUtODU2NC00YjRiLThjYWEtNGU2MGUxY2RmNWFkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.P1LkIMSwJCYM0mBUuHjvKiahJoeJxOE681JlaN-DTR31HeLbpILZRHCXm7uLtio8DcwnM2MCHwiYS1gJxbXGAOvtxwk41tmytelgwv5Ou7zjrurLZSkfQZgFZgaOIULAHaiFbCQwUK1c1JHVtEvXEENYN4JaFQ7llTtw3c6elMEqyBmGG2FTz8pcxRb4KyrMgsyCJj_nQIWAb-DET8-0SVIjyHqMXb69XtahUnuOeVgBPRJ_ucXfQPt5yOvdCTbwwP2sO-REYJwU_Fsv_6W7rIMsGMoNhlRiy-70O4mri9_majAQul52t9W2R39K6weJLcJA-xh3yY2hOhbF4ZYENg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1911
[ {
"id" : "008c5a68-a154-4628-9078-7b61c84ee65a",
"resourceActionId" : "80d49462-9de6-4a1b-a3a2-13aa5a5bbcc7",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:12.636878Z",
"updatedAt" : "2025-07-21T15:50:12.636878Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Read Network Version, All to All Authenticated Clients"
}, {
"id" : "4946888d-76fe-4e98-98a2-5db110b96d8d",
"resourceActionId" : "19b05d2a-7ff7-424b-9ce9-cf85b746248b",
"createdBy" : "e514b01c-73d8-47e2-bf1a-e3954ab04e26",
"createdAt" : "2025-07-21T15:50:45.075545Z",
"updatedAt" : "2025-07-21T15:50:45.114689Z",
"deletedAt" : "2025-07-21T15:50:45.114213Z",
"deletedBy" : "d2715d14-3ac1-494b-91b9-a313e1b92563",
"path" : [ {
"resourceId" : "22ca5163-fa92-4920-b49b-f28fc416cd6a",
"resourceTypeId" : "8f578dcb-fd7b-4162-8d40-0cc52dda6f38"
} ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action 49 Test Type 48 on/under Test Type 48 22ca5163-fa92-4920-b49b-f28fc416cd6a to All Authenticated Clients"
}, {
"id" : "615f364b-46e2-46fa-b9a9-c18235b46a63",
"resourceActionId" : "50b6014f-12a5-4ead-9aa1-dee54918aac4",
"createdBy" : "9309bfb4-0c11-47ed-9394-d43bedf43cff",
"createdAt" : "2025-07-21T15:50:25.901395Z",
"updatedAt" : "2025-07-21T15:50:25.901395Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "41ee4045-4c3f-420b-9eaf-caa4acbb5f41",
"resourceTypeId" : "8719bb60-6e71-414e-9b25-62a96c6e13f0"
} ],
"anonymous" : true,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action Test Type on/under Test Type 41ee4045-4c3f-420b-9eaf-caa4acbb5f41 to All Clients (including anonymous)"
} ]
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/e6b2c2ca-8ac6-4242-9d36-68c651409cd7' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJWX3dnNEpnTURxelEwMFNTbEdsSEpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIzOGI3ZjBmLTMyYzktNDhhZi05OWZmLTJjMTA2NmI4MjY4NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NCwiZXhwIjoxNzUzMTE2NjQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWY5NDRhNTEtNWNkMC00OWQ5LWI0YTYtZDhjYzI4MWU5MzJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.dv-ZJGr58ynhFcwmAgkVIsh_r5fpBC4pU6MNYueKXLDp2Mdb4UDLnMtrrInORmGm_8Cy0K3sYgwxmij-0pfPoYplVd3YAiq8cYQGG3NliVnL4gxQSHulk0u9dczBEPCjbAmV7wmyUfgz9clp6wLmhWG_LmAgWkNfU70utBL_oSFae87cBUfb-gRXC8LTfPPQmDASMd0PYv8tFHsGC3DRxwP7bfdw6LEXkpzqTKSGB_JyDhdsajc-HaXtnygrYvEfiSiBkSf2NC570ip7ETjgEbP7TASOCtvydldDiB4R-9Qo3aDrHq9HtD4afFZ5cAxJ7OxNOsTN5PNxGjDRVUHL7Q'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 678
{
"id" : "e6b2c2ca-8ac6-4242-9d36-68c651409cd7",
"resourceActionId" : "739c0400-ae06-4165-a476-591d5ffd0486",
"createdBy" : "be597627-2e80-46f0-abab-086cd036511d",
"createdAt" : "2025-07-21T15:50:44.917745Z",
"updatedAt" : "2025-07-21T15:50:44.917745Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "c7ece7b9-bcf9-41e6-8615-8ddf1adf36c3",
"resourceTypeId" : "95e5b7f4-46d7-4411-8e03-587f9d46c390"
} ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action 46 Test Type 45 on/under Test Type 45 c7ece7b9-bcf9-41e6-8615-8ddf1adf36c3 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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJMT2tYTEg2T1Rxc2E3OG9STERIQV9RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhjZTU5YmJjLTFkMzItNGJlOC05NzZjLThmMTI4YTQwZWRmMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NSwiZXhwIjoxNzUzMTE2NjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODYzZjI3NTQtNGIyYi00YTllLTg0ZWEtYzM3OGYyODQzNGVmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fSx7XCJpZFwiOlwiMjA1YzQ3NDctODVkNi00MDllLTkyY2ItZDk1NzA2MTNhMTUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.l39_pss4Tr2z5L45_cMF-NcHPAMhmq4OYD27VGxYc5e0sknuxDZED36Q2B0h7QXGd5sTYT8wQ3D4KrA_9HeFF1usTeGyrrytev0fsd0jdZJkuGX1p6UT4mM8HdEssMNxLvLYqm3kXEqdEV7lHfPZ1MA3lMf7sGLS0t5ZQZRiXEp0Qx3kBWcr0M-yA7-UzNSuap48P5dgdmxKQVl0kvR7zkvCFJYbimZscnNfx2mE2jKQa6t3DbJsmEJG_Z0fSp4O8IB8yMTfWklKyx1af1h3hQ3IOeYdnDDL62I36xEmyaAf-H7wqrAw5knryTG75-IlMizes4OMbN2mKz7Q9U0vkA' \
-d '{"resourceActionId":"50b6014f-12a5-4ead-9aa1-dee54918aac4","path":[{"resourceId":"49b21661-c484-4f8f-b7c5-3ad71fe7017d","resourceTypeId":"8719bb60-6e71-414e-9b25-62a96c6e13f0"}],"anonymous":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669
{
"id" : "5a2346b3-22b9-4225-bda8-f64fd457d00c",
"resourceActionId" : "50b6014f-12a5-4ead-9aa1-dee54918aac4",
"createdBy" : "8ce59bbc-1d32-4be8-976c-8f128a40edf0",
"createdAt" : "2025-07-21T15:50:45.261022Z",
"updatedAt" : "2025-07-21T15:50:45.261022Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "49b21661-c484-4f8f-b7c5-3ad71fe7017d",
"resourceTypeId" : "8719bb60-6e71-414e-9b25-62a96c6e13f0"
} ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action Test Type on/under Test Type 49b21661-c484-4f8f-b7c5-3ad71fe7017d 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/4946888d-76fe-4e98-98a2-5db110b96d8d' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiIxNDhVdzRBb2lUV3JBUExDNkl0T29RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQyNzE1ZDE0LTNhYzEtNDk0Yi05MWI5LWEzMTNlMWI5MjU2MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NSwiZXhwIjoxNzUzMTE2NjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjQ5NDY4ODhkLTc2ZmUtNGU5OC05OGEyLTVkYjExMGI5NmQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjhjNzA1YjktZmUzMy00NmJlLWIxZDUtN2Y4MGI0YjQyODk1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IbpUW_4SDQBBTgb2LvhUI3yDubY3P-gkWWKzYQdV9scu9EpYdNeoYAeKgJ1pp5JvFams4QBUTcg2zBRmaDMYait6NPhS9SpPvRE28LzfajO6svnQfYDmpNRRTIUYigBhxAArcTpMZIA9IraAOKtXsuMErQyqQ0D34XbxIv99VhHzHTeKTN1jNnhN2oKIV0QlL3BwuDVZrk72z9jOwTXbJCgV0qX1CdaFVSa0u6HnMOwjuFpTidY_kGLrfOWXAJYt_BQBGAMVfzt3Yh-t3898PRp8B63IoCJeJSDe2d6U-AOX5RHGpqTukR0S9j751d8bggUItWACAfAIn9XnKXDHQg'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJlZlUxVk1PNUxYTVR6TmoteHN5SHR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdlNGJhMGNjLThmZWItNDAwNC04YWUzLTQyODY0MWYwYTU5YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NCwiZXhwIjoxNzUzMTE2NjQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWQxNzA0N2UtOTJiZC00YjYyLWE2ZDEtNTQ2OTBhYzdmYTU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.KngCOecukYwOgmG5XE5sH-SOm7md8jtn3NbV1oM3jfujyY22PK0vYQwquBR-VEBtSsSRaZsnI7o_VqYfMDLW46mv2EYwcIh7zvUf0Yko2wmzSgh8z_s7OqZUZ78iLWusVoF1_Ac7tfmU2cT4eYVl_xgHdlwdu4DrHWPL1X2sA9f2mTXtrSj3l4k4JQZaxyOHksdAoKgf7B_psI5IQXk2xQ5INTV28BzkMz-T6ujzQ4l1nMghc4adKQr7aA3r5RvAXkoLgT_XTyCqahuuQ1KVeCO5xG8B_LBASYi2yDym2W0_MkSaTGd1czAbhdwzLkVvI9FcRlDpFUNUQWwOgwcJEQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1714
[ {
"id" : "7314860f-c866-43fd-884f-c628c9e92b16",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"resourceActionId" : "09b248be-c08a-4a36-9f83-8db62c6c5bf2",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:12.650295Z",
"updatedAt" : "2025-07-21T15:50:12.650295Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Update Organization, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
}, {
"id" : "f3a9489b-b90b-4c7e-9fb7-15fe96a2023d",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"resourceActionId" : "46db9660-aeaa-40f7-b9ee-9862ee218bda",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:14.425768Z",
"updatedAt" : "2025-07-21T15:50:14.425768Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read OIDC Public Client, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
}, {
"id" : "8e786b45-99ac-4dba-a5fb-4f4ac97faf2e",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"resourceActionId" : "9e549c33-959a-4beb-8334-7ef2beb556e8",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:13.896432Z",
"updatedAt" : "2025-07-21T15:50:13.896432Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Delete Standard Role Grant, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
} ]
Get Identity Resource Action
GET /identity-resource-actions/{id}
Authorization
This endpoint requires read
action on the identity-resource-action
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/identity-resource-actions/04c13415-5099-4f6b-89e3-b9f162e0d87e' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJZMElyM0xqZWhSdzJDMFc0QlhJc25nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc4NjdjZjQzLTBiODktNDE1ZC1hYTZjLTNkYzRiZjZlNjNlNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NCwiZXhwIjoxNzUzMTE2NjQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTk5YmQ5ZjQtNDdjNy00NGUzLTk2ZWItNGU3OTFjODViZjc1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Dt5UDLFzxHmzLk4xdIZJOV85-DfMJHeomPzQ87fRV0vxyxvQ4CvlfPDtuNnhNPt9M63Em3bjsXpkGEFRZJ4wh6X3vxZydd2ES0uRjukd1VRrp50-pQbA_ltQItsAMQlT_v1InmQa3Ry2TU8P6d_OJ3vNB69vXwzCtHhKFW4kauvDTCTfdYfAaLIzUQhqWMG3fsAE9E5X4BYNNfN6CVPtFJKCG7K_Y2zpTSAiGPtdfn9xilY1_8OJmx9WA19N9YhXe9soYlhPDxfg5cjMCaLwQ-NCSD7RsV7aTminEPLQ-r3pEhjBurezEX1Q9NhV92i_UhnqPGmgFi3ck-3bXYiigg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 754
{
"id" : "04c13415-5099-4f6b-89e3-b9f162e0d87e",
"identityId" : "a69a847d-0cb4-4283-82bd-3dab35f78400",
"resourceActionId" : "373a1265-332b-4790-81e6-861ae73cd6a7",
"createdBy" : "05899933-4da3-4740-b69d-d6df7d61c0d3",
"createdAt" : "2025-07-21T15:50:44.657426Z",
"updatedAt" : "2025-07-21T15:50:44.657426Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "2bcc12fc-b14f-44da-8b57-6fd9cb6b88eb",
"resourceTypeId" : "cf6dc796-dda8-4e57-925d-76c5ea9bb022"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action 43 Test Type 42 on/under Test Type 42 2bcc12fc-b14f-44da-8b57-6fd9cb6b88eb to identity a69a847d-0cb4-4283-82bd-3dab35f78400"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiI4VFVLVzFEUVBiR0p4cFpaSERFUzVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQxNmRlZWQ5LTQ1MjYtNGU3ZC1iMDZjLWNlMjFjNmNiYTFhZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NCwiZXhwIjoxNzUzMTE2NjQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2Q5YzE4ZTUtYjFmMC00ZTc0LWFjZDEtODlmYzk1NjNiZmZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ0fSx7XCJpZFwiOlwiMzUxNzkxZjEtNTAyMC00ZGNlLWE2YTItOTcyYWU4MjEzYWI2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.d1uuwjBbDi5YfgvtPe4RB7zJPw5sWpw3z4Ot0NZ_dvlL4dtB3seU6fcDagxe04nS2plgXtbEC95qjgOe_lTXg8Bsy7K6lDr4Muxvi9hbG-w3sPG6JzkqfQaLF5Tnjw5vyH8jTI81EiFcZ5e2FLNipQh9_9LQzTcYaMoBzlqefhVGT-HTQp6sKzWGrCElpRSZfns2G62k6poAPgGUgvVPb2Wyawq6swAwAjqp4JlZLfCTgFOteNqRuyOI-Cc4HlcWwdBJuuMCDHvPhfjl8BNFaxD4OOkdFCStE9jq6w44KrmU0iT8uZSiiQtkMsNcXAuhmylN2svXAfY6hQBT_RN_0A' \
-d '{"identityId":"d1b3be8c-a482-4895-8ee6-d45f61d15038","resourceActionId":"50b6014f-12a5-4ead-9aa1-dee54918aac4","path":[{"resourceId":"2508c43d-2886-42bd-a144-4f06e0d5b838","resourceTypeId":"8719bb60-6e71-414e-9b25-62a96c6e13f0"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 745
{
"id" : "152a945d-6f88-4fdb-814e-7b2984bd1351",
"identityId" : "d1b3be8c-a482-4895-8ee6-d45f61d15038",
"resourceActionId" : "50b6014f-12a5-4ead-9aa1-dee54918aac4",
"createdBy" : "416deed9-4526-4e7d-b06c-ce21c6cba1af",
"createdAt" : "2025-07-21T15:50:44.831309Z",
"updatedAt" : "2025-07-21T15:50:44.831309Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "2508c43d-2886-42bd-a144-4f06e0d5b838",
"resourceTypeId" : "8719bb60-6e71-414e-9b25-62a96c6e13f0"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action Test Type on/under Test Type 2508c43d-2886-42bd-a144-4f06e0d5b838 to identity d1b3be8c-a482-4895-8ee6-d45f61d15038"
}
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/b8859302-dd7c-4aff-8aef-6d977127aa4b' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJvWld6M2tEQUt4Wm5DSE5VY2Q5cUhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ0ZTA5NmIwLWYzYzQtNGY4ZS04YzdlLTk3MjI4NmRlNGU4ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NCwiZXhwIjoxNzUzMTE2NjQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2ZhZDZjMjQtNGY3My00MGMwLWFlZTktNzQ4ODc4OWQ0N2ZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.kn2I9OVB3qGLX4gNruOjhPbG-rZMBQxSw1iukHy5Jzw16jJdxu8sCypDcYrasrCHEMn32gnmxtGPM2wHE5CtTT2oIh7qZWCkZBfzhEJf_b11EdtvdC_kiSehW9Ks1TgWObJZePoNL3nIuQWV7y9sWcKEnnC4zcQgTUwL0Gw1-aTWKwDM-dZsMAIjd5qf-ps-8loHb9jr448K_ykJ5kkw67ZPAHGyiwvICe7G3d4S5o0008obVnooVF36PSTfzhiTRCbZw9LHhJAhvjU-QQLZmBv6IV0PUMPwX9SCsFwlFOq26i_-JgJrLz_ybkKKrMbkxC7A_uGptF5enaa3wLoYXA'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJnN09zN04wUTJsTEdMYndsekoyemNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJiMzEwZmYyLWZjMDMtNDY2Zi1hYWZlLTcyYzg5OGM5OTYyNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MiwiZXhwIjoxNzUzMTE2NjQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTJlNWQ5NmMtYTY1Mi00ZTUxLWJkNDQtMTU2MzZhMDA4MGM4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.N22i8RyzqyC7i0kYvWwP2unNaLWcGaAAYPrTbD7eXA47Z5fWaHiWaoYHLzTb9quVUXe56ACraFu4RlHC7OyHURv9SWQvw4gU7ACKhrOtLLY-dN4fHQVLjffoGtAhGohKnTvogtx1Psl5hHVPB6aqIfJOY6XtQsj1QnOC4dg1nG3LqDvnpv590yPKxwuKYkTE3jZXlmvmyyfFJCTAgXVUjyQ5_gW47tekrfBxsHvx0VS9NdQBcliwoq5wNwWNzrTH1urqNRHnoT6ml4Ct6XAD05Np6NG-2IPAhesN2OIfgTXREDyM527DqmMydo5ohJ2LkODPIldXxutLVrpli_IOdg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1199
[ {
"id" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"name" : "Read-Only, ALL Auth Domain Resources",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:11.056982Z",
"updatedAt" : "2025-07-21T15:50:11.056982Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Read-Only, ALL Auth Domain Resources"
}, {
"id" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"name" : "NF Support - Intervention",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:13.981125Z",
"updatedAt" : "2025-07-21T15:50:13.981125Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "NF Support - Intervention"
}, {
"id" : "3d2fc2c2-8af2-4f94-8635-bee532dd3399",
"name" : "Onboard Trial Customers",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:14.730193Z",
"updatedAt" : "2025-07-21T15:50:14.730193Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Onboard Trial Customers"
} ]
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/4b8af55c-ab68-4959-9dbd-17fcef3483e1' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJocDdhQUdrbHZWbVIzcFZqamxGa1FnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRkMzQ5ZWNmLWJiZjgtNDM4YS05MzkzLTc4ZjhkOWQxN2U2MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MiwiZXhwIjoxNzUzMTE2NjQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODI2NWU0Y2EtYmIwNC00ZDlmLTg1MzktOTM5ZDhkY2ZkOTIwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.W-3wTU-KVmV4LNVd51AinXZknA5wXHVIuAgaGmcG5WHfbT7ObTClEfTk2nzTz3baOSsslzdeatnpSBJpGtwmSdJYN1PVknmDC0GjStv9e_saqbz1szNLmmI1jgPndZS3xcq_SyqMGk1Y9DPXaK1Z3zsyiecTnHHEWewcVf0eN791h9AwlGUbjdhOcoL7oxM6QX0kf4J-NgfWhBSpIGgjS64gqYH5NkdHlgtyQwZRNwpbUXTceKTSKl3lWraVZSjgePGrA74wHmQN-VPz0z9MwzlayTuMdrrBxu1XqWaibCtsKdU4z0kvgULD9YszHxY6VcxENgFSfCXosy5TwZqCKQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 379
{
"id" : "4b8af55c-ab68-4959-9dbd-17fcef3483e1",
"name" : "Test Custom Role 31",
"createdBy" : "4610f4da-0fb5-4b20-92c9-7b1ce7a83cd0",
"createdAt" : "2025-07-21T15:50:42.239315Z",
"updatedAt" : "2025-07-21T15:50:42.239315Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJzV3J4Wm9iLUpMbnNPY1h5UGhUbmNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI3NDcwMzg3LWM5NzEtNGUzNy1iNzdhLTNlNWQ3Y2MwOWUxNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MiwiZXhwIjoxNzUzMTE2NjQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTg2MDRjNmEtMWVhOC00YjhiLWE2MTgtNmRhOGNjN2JlZGVmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Dw1dik0w_atQ7qmgJroeb9yYxBdJa-9TN4lacAPFQfq851y-7HB7_ffY4rRtf-CM9U6pVf3wnQdUJTiaAuPROQIGRuL-tl6k8jKaOJ1z5E9jxIInriUse2NaD6QmJKq_JjQD6FLd9LwSq181t8CVJRgLfKY0muzbm4IUgi8S8lJ2DqYbLiGAhIOCCpp3Zr7NB7eI0dsk9bn3mmQjodbqAlBWqFOZyQRJ2sNGKHCokeQ-s9KtUHLt08veSbGBMOPtqGH2hpE3Mlpt-UzTshfhGX_T5wfzFSVdOjjTounl2pgBxh8dvZP8AkA_XqEXUyaMgmV-e1nSnNgog9aw-UqtnA' \
-d '{"name":"Test Custom Role Create"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 387
{
"id" : "1c679dd2-5fd8-434f-9312-f15e48946685",
"name" : "Test Custom Role Create",
"createdBy" : "27470387-c971-4e37-b77a-3e5d7cc09e16",
"createdAt" : "2025-07-21T15:50:42.780890Z",
"updatedAt" : "2025-07-21T15:50:42.780890Z",
"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/5922cb72-c0f0-4b18-aa8e-4006bf004091' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJRQ0huT0c0UU9KNDdXQUhtenp1NVJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYyOTk4YjEzLTMyYmMtNGMzNy05ZDdkLTllNTVhMDYwY2MwMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MiwiZXhwIjoxNzUzMTE2NjQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDhlODNhZGYtN2MxZS00ZGViLTg1MjAtMzNlMzQ0ZDg3ZTNhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fPLrPJJLyrd8bcJLccE-6-ZZpN3Vmx0W84HDLuyxMLdTpGS4XEPi7l4SF6p2y0PBvQ-n6SK7-hBA3hmIGcBzMENRZ4s4qMFTCHSECAUKIMwz-8lWv5jbMqSDC_DOY5WRUZfOWcWpM_-NVP1RqUdzKHM9ovXg4VTBwudRbBRRmuO-Gb-BVDqY2pamcDYMxtfpXjm2Cu3o6wBxoZXiWQb_RBqyNQBFGwmhDXQFYZJnvZNdFo9i9ovtTTrQFTeh1yhkkK8ASyg9tayS9HPfMAFNiiU1YZYwZyyOSP7uIr4SFWIWeI3b8pZCpsrWqYc_XKtX2SQsquP9uOptW66016po7w'
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/1ea6c15a-ced4-4d16-9a40-cbbacd5657d3/identity-grants/78c05dbd-b8dd-41f2-a9f2-eed7a8572259' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJLRy1CQng3Xy05VlBoVk5ROWtERW9RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRiZTZlMDFiLWUwZjctNGI0Ny1iZTE2LWRmOTBjNTYzODNmMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MiwiZXhwIjoxNzUzMTE2NjQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNThiZDMyNzAtZWI2YS00OWRkLTg0NDYtNTAwMzFjYzNkNmRkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfSx7XCJpZFwiOlwiYzVlMTM5ZGQtZGU0MC00ZGE1LTk2NmItMTVmZjRkYmE0ZjdkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QtjtW_hf0ou9DHlrg82dyi8mvOWPL4GNPElDKEyu6sJV2WD95GSuNdcnZIgd8BdJqgb8iBEbTEqeyh-V4ETjJAB1OtcS4h0zVm5aoJ0DmNp4KdbLGRoYSsKMnhUPGUd6xpyz6XG2J58X8q5X-DRQ_TpnFST7tivp1kz7nuxcPvSeVw4SfYxZlKv8IOVvo7b5wS3IuezGM8qLRQ59NbZw0jSFZhgwBOi4yvxSwSvDCNQ4X_7JeCaP--0bGXdq3wBojfJ7p03ER7vafdZ4X0gT5I77EmHzVVshb7cF6lP6HMN00SAx5m8_MOlQMTc7cwEU10D8RVFVzw8FXg56GdjpHg'
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/8337e399-60b0-41d0-9eba-e40dcfd46839/identity-grants/1264af52-c2d3-4cc7-90fc-eb11f6060d2c' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiIxVG5zRlJaVlBScmVOZWM0enNfSk1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJkY2E0NmJiLWExZTYtNDYxOC1hYWMyLTJmZGQzMzRjYmFlNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MiwiZXhwIjoxNzUzMTE2NjQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjU1MzA1ZDktMTgwZi00M2FiLWI5NzUtYmU2OTVkMTE2NTY5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfSx7XCJpZFwiOlwiOWQ2ODE4MWQtNmY0OS00N2QyLWIzYzUtMDlkM2JjNDUyZmZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.pvKYVwAsrUGn8dpC87ldA2FJgaMBV9UT5rcA6xUNEHnIQR8s1OT-F2iBhoikgcOrZmGmXKOWeQVVPgkE2hz5yXkieMXGIaaNMDfuAhVVihG6VHjAnGX7maq7l3wy-efEsauFvW7uToqri61XzEfBPQdxfNNOehM-8iwqwDuGeK67zb6KaUamON4whGXNkNUPcKn0Cml_7w9o10Cfzg1VzQLZHreCnKyH2jKJY_HP5o88v7sSPIZ8rUg9XrOu-HRoRW0KQt1RZFe14MWeQxsXBSlbsULUQgqWE9uxA2epdP0VQWMtvymNzDEcpZlgQDdLfyLs0au1gyfR24zKMaHI8A'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ4Q21fSDZfRHZKZjJoY3lmeFlFXzZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVkZGE1ZDk3LTc4ZjAtNDRkMS05ODI1LTI0NzQ2N2MwYWQ4NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MSwiZXhwIjoxNzUzMTE2NjQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGFiYTlhYzgtZjlkMS00YjRjLWJhNzctZTYwZmZhMTA3MzdjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.qPAOy54OVmGL3iRd0SmbHMclWniQuiLnNtM9IGNiB0FeDv40a_clv4fmT5UtAJXZmRL6-VgyPIE9ZiEc-xTyjpRiuTKBKNMIQCykL4BnFPIw-41pHpdMyvQiIYX175aCQEDYOprPZlaQy6ztsqofyH2KN2Ynp_QAqDGYFWH1EUA53WGHiHfvwIt9d5m4orU2ZbeDS5MhZdfLWbmKgJ1JAz_uMZZc3gtSuG__IruETKM2rZ-qUk1ITtQjlczFjiQb4refSxzJlu34QWFrneqgjMXhixR8RAUiPz_inWwYojDvMdEGqHNeUkyF3C3cmTNGkqCWY9uP3PsXqfSxQf9tAg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1292
[ {
"id" : "d95e4573-e160-49f3-849e-3d270086680e",
"customRoleId" : "f1e3d5d9-2899-4df7-89ab-297d29cc54bc",
"resourceActionId" : "e5f8f530-9490-443d-a8db-a335e456c395",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:13.981979Z",
"updatedAt" : "2025-07-21T15:50:13.981979Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Edge Router Policy, All"
}, {
"id" : "46952f49-c9db-42a0-b46b-5485faebe022",
"customRoleId" : "74a9a6c3-106c-40bc-acab-780c837ad8d0",
"resourceActionId" : "8c722533-04af-4b9d-b473-3162df8b5b81",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:11.503620Z",
"updatedAt" : "2025-07-21T15:50:11.503620Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read As Code Network, All"
}, {
"id" : "a20d850e-a04c-4d99-85a1-d55069067f3d",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "5beb4817-f8ee-463d-87c8-5838afb7ca51",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:13.986517Z",
"updatedAt" : "2025-07-21T15:50:13.986517Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Update External JWT Signer, 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/082f3593-33bd-47e3-bd67-c3ea41bf35cd' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiIwNmlTR2Zvd1c2MW11azdoX2RUQWpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI2OTFhNGY2LTVlZTItNDI4MC1iMWE2LTZhZGMxMjVkYTlkZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MSwiZXhwIjoxNzUzMTE2NjQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGExYjc3YjktMGUzNi00YjExLWIyMDQtNzg1MjEyMDA1MDZmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.pPQDDJhgwLNCEyUSV1uQJwiyYm7hTvvxY0kwlUqoYTpi4rB5910TSTaDxbxCPv1YWOP1fqxm28GBkNNMCbpi9LElaHTZKHUP8DtSmaZpInYH4EE92wHynoaLrpw-fOLkPZDOuqjCF5w3bPo7ZOehrizOA_24knsj_5gBxplHH4f7vEwTDjQMLqUgr_H7L0_1-2UZs0D96aKm29PjgxPRQGDtG3-wbKOOZCf4AJXduhHhvQGvKkC0dYV6Z9K0AhP1azIRk0aeB2I55eF3ePSXs60-KIKUYsE4NpVGzljai6PA-WMlG3tfWtgfnQYCsn-WfDAdKpKKYwG23X5Bw0JIQA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 613
{
"id" : "082f3593-33bd-47e3-bd67-c3ea41bf35cd",
"customRoleId" : "5b505d4e-0bc6-4374-bcfc-a30e92c1ed77",
"resourceActionId" : "00914657-ddd3-42eb-bd55-f0b58e261a68",
"createdBy" : "b9544990-efd9-4670-a21c-cddf9d2a0056",
"createdAt" : "2025-07-21T15:50:41.552240Z",
"updatedAt" : "2025-07-21T15:50:41.552240Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "3e3b7c14-ff55-46e0-ae61-d1b396ef917d",
"resourceTypeId" : "8e73793a-b189-43df-8dda-6c060cbf3d52"
} ],
"_title" : "Test Action 26 Test Type 25 on/under Test Type 25 3e3b7c14-ff55-46e0-ae61-d1b396ef917d"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJwUFpSNk5NNzZpZHJIczV3bENSdnpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgzNzE3ZDQ5LWVkMjYtNDgyNC1hYjU1LTUwOThkZDE2MDJhYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MSwiZXhwIjoxNzUzMTE2NjQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWM4ZmJhYWUtOTgwNC00MWI2LWJlZTItM2ZiZjNiZGExMjRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQxfSx7XCJpZFwiOlwiMTMwZDk1ZmYtMDljMS00MjMyLWFkMDQtNzdlYTQ2Nzg4MDExXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQxfSx7XCJpZFwiOlwiODNiNWM5YTQtMWM2Mi00ODdlLThlYTAtZDhkNmEyM2FlOGYzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.l4jonpKksvZ8hL_rNEF0DLSiHbpiZcgmfOLvaeHl0Gx_SPUwRUiv9MI3U3B8dfUgJe2lyMgPyxlI06ImMStqNWbpsQMZSeu1ODN0vGrVFyHauykqRYdIdAR80hEfM5wlXwTXDvXHfKTPnUu-J3KhtIUFvHMQOZu5ozSeN8XSDoQv0paqH05kly70KX4vH9Jf78rsUS6idnetgiCF7l4MdswWIcsgPVrkBO6HiTyzMKuZnxBO916t3gZrQIcEysUTQ8NOm3d5m-LtK9yofZfUPRFyOs-Ndgtn8C5ZOoMqCWH7Ua3FNzhVcowJwKOUaaHTbd0gWv2yhDfksT3EENP7_A' \
-d '{"customRoleId":"f320c7cd-86bf-4456-99dd-d505638b1103","resourceActionId":"50b6014f-12a5-4ead-9aa1-dee54918aac4","path":[{"resourceId":"422310e7-0104-4eba-b462-795f4db9b0e0","resourceTypeId":"8719bb60-6e71-414e-9b25-62a96c6e13f0"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 604
{
"id" : "114e7217-d6b6-419d-9a6c-11efd334b349",
"customRoleId" : "f320c7cd-86bf-4456-99dd-d505638b1103",
"resourceActionId" : "50b6014f-12a5-4ead-9aa1-dee54918aac4",
"createdBy" : "83717d49-ed26-4824-ab55-5098dd1602ab",
"createdAt" : "2025-07-21T15:50:41.351673Z",
"updatedAt" : "2025-07-21T15:50:41.351673Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "422310e7-0104-4eba-b462-795f4db9b0e0",
"resourceTypeId" : "8719bb60-6e71-414e-9b25-62a96c6e13f0"
} ],
"_title" : "Test Action Test Type on/under Test Type 422310e7-0104-4eba-b462-795f4db9b0e0"
}
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/8d0914fa-35b2-469b-a726-0b62ab195ad4' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiItU0ZDZW9uSHp1TmU1VmN2dE9obDh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUxOTdkNjE3LTRkYWMtNGI1Ni1hNDBiLTFmNjBkOWQ1Mjg1MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MiwiZXhwIjoxNzUzMTE2NjQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGU1NjJlOWUtMjJkNS00ODY5LWJjZjItODAwZDJkYWIyMmE2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.xXTR_VNYnNLKHqB40lTFP-hlHrj5froQKXuFecO9F0mb6iLgcYqqi_aEne3ManzDRfqZFxzuI11Zu8P8J-vFhaYU4DSrILEMetle1J_ey2gCQLqG1YEazsumlwbOOsx3aPYGspkWvrjErQ8TwF0CmFRmymeoQrJsc0VZDJI6-OIVVNnJI44ITnbqYT-IdxzxD2aYo54Dz90SoxrMzhUOR33_VXv3Krszc_BKvyHTIjKmzdSbrxD_mf4YG9BdgIrTPvze2JqbM_72OhNZ4kqEJ6c37QQNkFyztttXxu23GETh1xKjst2eoCFQB5NJnW6tE0aIFDnGG2G_O3_I9zUTmg'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJiT3FkM25WUzVNa21aMDI0SG9uUFNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE2M2NkZmU4LTU1NDEtNDJiZi1hYTA0LWRhNzNjODI3MWFhZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDEzNWNhYTUtYzcxNi00OTg2LTk2MzItYjI4MGFjNjhmZmU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ieHW7hvO_wg39HjihhdiXxFJatgbpix_gS_rVhLYak_zTLt0caMxYY92Rj7vaVE7_PPXr3y5pmH_uUM9DO2Xxo51TCIynyDuCn5EgBnWb9832d2KR1b5ES6q6uRac6Ugn_gTr-KmfXL3WJ-8AoiPGpnyCNZoJlbj2vy8Ii3btFTLALHuBuBYLwpnHsf-3LBU__0lpOVfS795kYE20Af-EEMbSXp9R3B9wlqOPTSdDHrPA3OhduQTeMJELkilfQ75i_OwG088O0y62uyvS0MRNlcavZL4WEjCWEchuPkEUOmrTSclg12RBC-vXK5hq-gV--M61W09KNqZnChBLrVhBQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1415
[ {
"id" : "c8eeb3f5-1ac5-4023-b360-e9f97c7de287",
"identityId" : "cc1c1b23-4e71-455f-a38a-2c828d04c34f",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:14.687543Z",
"updatedAt" : "2025-07-21T15:50:14.687543Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity cc1c1b23-4e71-455f-a38a-2c828d04c34f"
}, {
"id" : "e01f54dd-ded7-4d79-b67d-f41df30ac715",
"identityId" : "e5f14eba-5792-4a1a-bcf1-9fa176637dd5",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:11.077077Z",
"updatedAt" : "2025-07-21T15:50:11.077077Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity e5f14eba-5792-4a1a-bcf1-9fa176637dd5"
}, {
"id" : "d1f5bf10-2b51-455e-8906-83670a70f06f",
"identityId" : "16f645d6-e5ec-4d27-a542-64891f58b3a8",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:12.435174Z",
"updatedAt" : "2025-07-21T15:50:12.435174Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 16f645d6-e5ec-4d27-a542-64891f58b3a8"
} ]
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/774d8c9d-4b43-46d8-9329-d5c62265fa0e' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiItOE9yRWp1cno3cHFSN1g4VWJiMkVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRmNmFlOWMzLTVhMjQtNDc0Yy1hOGNlLWI2NWRkMmU4ZTgxMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGFlZThhNjUtOGQ2My00NDNiLTg0OTctZTU4YWE3OTY2MjVkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.CQyCnmj5C95ncM73dtQzU9oXg9pBnWvTHSqm-RlmQ0f1DeetR0ND0TkOrpB133ty6dAOTi-deqlRN37rpECdPFZS-RRGxyVoKCftw9RU5emjd5g6-Om_XyCiM9a5xyVSt_-Z7dFMLhxQ2Qsxdr_sz0vDrbCYJ2Kac7Rwc8R_TdlqiJ-yeLaqmPv5URI5bFLq_EoJtCywg5SNhOzm64Vj2-jee5-C2fhrNIXMJeUChdtOtm_-DoJhdrGbVnaZH295DzA_H42DlT0ARVon9mnNt--7go3KHcUoRulcUSyWSm_yE2L0IjXONKNJNO5-bO4-ss3PbuMROOjlUu98lMlPzQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "774d8c9d-4b43-46d8-9329-d5c62265fa0e",
"identityId" : "f4dbd483-9f36-401d-9d1d-b46857a94904",
"customRoleId" : "19c1c55f-cd0a-426a-9415-404e1668749c",
"createdBy" : "83d272ec-3d64-4dbb-bc17-75e4beaf4547",
"createdAt" : "2025-07-21T15:50:43.058827Z",
"updatedAt" : "2025-07-21T15:50:43.058827Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 35 to identity f4dbd483-9f36-401d-9d1d-b46857a94904"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJxMTZGd1VNZVlmb01ORG9vbzctZm1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIzODdlNzJkLTMzZDMtNGUxNy1hZTRmLTY5Yjc4ZjcwOWQyYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjc4MTk2MWYtZjU4YS00Yzg1LWFlMzItYjU5OTE1Yzc4MDBjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfSx7XCJpZFwiOlwiNGRkMTkyYTItNzE1MS00NDk4LWIyMDUtN2QxMWQxM2NkZjNkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.xVZSlbIbamramCWzLmopcwN6rrkNE-aZNwaZ2xpZ_UimvHdYiLcBHLoIJ94Bhf1WyEsceIgeZ9jZ0vaF3UvVXOAeBcG4pMKetSDMyex6obte1Pal62x0NntM0Ttz_cT8o30viwH8-t27ESmWhlXy2yoC-iI-9CDCIiCFgylzN4KBJQ2cYg4sSdzbpGg1z8vgx5fUBuw0E-_d-xuSERMVdprzSxpBaDChSvNkWiWHOAJTI1OGewv6XzT2SPWJvFjIzBCCyiVB_a2R1etYIPXMXPwhb20B9h8-DmwjkhpcWy99bnfTZK2rY0ZocfEFtu6SMBECxEi4wvk2Fzz_OXPcig' \
-d '{"customRoleId":"9f35bb56-1102-4681-8c62-59528939e7e3","identityId":"7f247f84-97ad-4a8d-9d8e-1592c27c86df"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "87b9095c-9f7b-40df-b19a-d943340a56d4",
"identityId" : "7f247f84-97ad-4a8d-9d8e-1592c27c86df",
"customRoleId" : "9f35bb56-1102-4681-8c62-59528939e7e3",
"createdBy" : "2387e72d-33d3-4e17-ae4f-69b78f709d2b",
"createdAt" : "2025-07-21T15:50:43.350571Z",
"updatedAt" : "2025-07-21T15:50:43.350571Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 37 to identity 7f247f84-97ad-4a8d-9d8e-1592c27c86df"
}
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/32a9a88f-cabc-425f-b950-f28ebc09e218' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiI0ZzBQdmNJWGhrM0xpenN0SExSRTF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg1MjIxMzJiLTNjOTgtNGNkMi1hZDYzLTAxNjAzMWIwZGFmYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MywiZXhwIjoxNzUzMTE2NjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMmYyNGJiYTYtZjQ4Zi00MjI3LTk2MmQtMmEzM2ZlMjg2MzBjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.OZK4itLR_BY2Z8hRbHvdEscvGCEFxxpY5A7bax3qT3MRMYYuSo1d5uDugUOzXF_aetzKJUKNVHcBQO-mxJ-gDHXBYqCzMm0UaG-4dYE6BzO-RPRqR_kasy7F7BS1L_5n661Sz_PbEXZYbOWHMqfZSzLHSB41WNKTi7zsSAIZSeiQdrFVhyTtFKeJazi3wmLLumwcDiWhuQ0JTYx9LNdPEI29V8j2QoFjkLDQcD36QHfT3uPemZMdnLyc1PW-SmD-8FuiAfqPRZ_OeEar_AW0TH61bsBjdaPsQzZWmjeHS3QTxgFDt-EF5S7L6z7iNr7jkuLtJbwdx89GBNHiXajNdg'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJCR2V1cHRQSFpURXc0d1ZxN1dRSldRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQwNjMwMzk0LTdhZjMtNGVkYy05NjAyLTdjMGM0OGM5N2FmOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NiwiZXhwIjoxNzUzMTE2NjQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjhkNjdjNTYtYWU1Mi00OWU4LWJjMWYtNzRlOGU3MzJiYjdiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.NEu33MBHx9dBcfwbBibd05m_sbd-kTqyhDqxyFpTO0-iLaDAVNwcTNQfQzfvqO5qx5wt5eEntg_6KX5OSxEtRZg3AbRqa4CenOWXQGZl9eBsK8rX9MAy1M7x4_Ce7na-a6SYmcPJdzd5AfcQ7yv9wqiDwCRuceSha6cTzTMMYI9QFtOM0oWrrXKvtfEFCkwey-KIZFJzyRBLbl9pMVGiHFyhnxPuvEQvN7fouZsMoNIZV3kqVhyULCY3srqzHykM5HG6yZd8lAutuKV-FWkTAi0EmQeBX2KHgiWqWYbluRQy9jsymnRG9eE7FeZS8iL0DzlkFleDqOYC-cD4Aa_TwA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1924
[ {
"id" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
"standardRoleTypeId" : "7f78ecdd-bde8-4bb2-8c17-04d45f533604",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:14.021373Z",
"updatedAt" : "2025-07-21T15:50:14.021373Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "f0428619-11bd-403d-8b00-a463ff8aad84",
"resourceTypeId" : "6c5b3033-0ef9-40db-9b8a-e9f1d3e20464"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Network Group Admin - f0428619-11bd-403d-8b00-a463ff8aad84"
}, {
"id" : "b75be358-a3f9-40a5-972d-a804c4758041",
"standardRoleTypeId" : "7f78ecdd-bde8-4bb2-8c17-04d45f533604",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:14.141745Z",
"updatedAt" : "2025-07-21T15:50:14.141745Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "bce07cd1-8f36-44a3-b279-26426e7a53ef",
"resourceTypeId" : "6c5b3033-0ef9-40db-9b8a-e9f1d3e20464"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Network Group Admin - bce07cd1-8f36-44a3-b279-26426e7a53ef"
}, {
"id" : "2854b8f9-6538-11ea-98de-128b2daaf7e4",
"standardRoleTypeId" : "c3ec46f3-3f5b-41d0-986b-48fe71d9de36",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:14.142620Z",
"updatedAt" : "2025-07-21T15:50:14.142620Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "7f78ecdd-bde8-4bb2-8c17-04d45f533604",
"resourceTypeId" : "5a75acb0-d52f-42aa-85df-ebd7ea8ee318"
}, {
"resourceId" : "b75be358-a3f9-40a5-972d-a804c4758041",
"resourceTypeId" : "fe35dbcb-952c-42d8-98c0-a1eb2fcd3a85"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Standard Role Admin - b75be358-a3f9-40a5-972d-a804c4758041"
} ]
Get Standard Role
GET /standard-roles/{id}
Authorization
This endpoint requires read
action on the standard-role
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
standardRoleTypeId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-roles/c61d83e6-da45-4828-9ad0-7b02e459067e' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ6M1pRX1d3RlJMb1U2Tm9tUVIyMi1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNmYWJjMDM5LTk5MDctNGU3My1hZjcxLWRiMjUzYWNmYjkzZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NiwiZXhwIjoxNzUzMTE2NjQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDQ4ZTY5YjktOGM0Mi00NWZiLWE5YTAtZWViZmE2Nzc1YmU4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.nSwTZqXb3QLeAVLT9gipA0wPzx4F_1Uvv9pVmXbB4ibNGs7N3fD61QBmHFObHfjybA6j9pZ2d78NOCswzJ9YJM2g0OIqEnG70Zgeoqg1vGmabkperlBDqmK6O4Lm6983zRDgzLeCAdtr8kXV19a6flkq9wTxcC0xZrRCOUKVl1toA4PZMSV8yq11p_1bsjo_bMnPGyYrxlr8eyY95o1WEjDJUTCn0RTHa13S2h7Suolp_WOyjkDNE5FcPtxqwYvJ-wi_JYwPMBxY1tBZNmFpjw_ocv1kZElf7PFBWqVo6EesHdkEgg8LXk2byumiPw0qgZ3LaOlzZaYON6O_rA1eBA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "c61d83e6-da45-4828-9ad0-7b02e459067e",
"standardRoleTypeId" : "eda543c6-5748-4cd2-8b48-465b3b4a26d8",
"createdBy" : "c769c2d8-78f1-4ac0-9d0a-81da9ce4918e",
"createdAt" : "2025-07-21T15:50:46.670714Z",
"updatedAt" : "2025-07-21T15:50:46.670714Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "2ff4a9a0-54a9-422d-987a-3ebb713975a5",
"resourceTypeId" : "962209bf-e5a7-4ffc-8f11-966231db97b1"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 53 Admin - 2ff4a9a0-54a9-422d-987a-3ebb713975a5"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJLMXB5ekwzbzhHbnd2N1lGM244TnJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMzMDFlZTBkLTNkYTgtNDIyOS1hYjc5LWMxOWEzNWVlNjM3ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NiwiZXhwIjoxNzUzMTE2NjQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2MxYzUwNjctYWM4Ny00ODM5LTk1ZmMtZGZjM2E0ZWMyMGJmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fSx7XCJpZFwiOlwiZTUxYWE0ZjItNmNjYi00ZDFmLWI2M2MtZDhjN2I0YTM2ZWYyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fpgDpVTT4eWb1VPeELH6tboAoVxNol18Yno1fedOuzjpQTCltqTuflDJUUGsPH6wI2OftmFZUn5Xe4WJKaa--kfKjqOWF1bTRwBIX7k90p1HjEns9BQkNsnE_J42dlaWaRykpXhDR0bzwxV15Eng7Bcdmi0rmgYDbT7sDg_vCdVjD2UQU4P-gwXuC6FzMyw6ECUolCNRZD1ZIU20cEMIu7Brl79i2VT2WomSCfyeEXDkWqZNi0m9I-SeXCiawBRrHFOLiDWcrKLFBG-EgZc5UK2Oj3Ma9YPqRENIx_VnOPLfMDX0rlmUPIPQ6-S2oKopQlDKV34LXU01V2fffkaYTw' \
-d '{"standardRoleTypeId":"9895f947-162c-4d39-ba91-3c3016dda785","path":[{"resourceId":"c1437550-c4fa-46ad-97cc-cc611b13f7d9","resourceTypeId":"ef7760be-e890-4629-b352-c696833afd9c"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "d2fc1107-5125-4240-87c2-16323461d01d",
"standardRoleTypeId" : "9895f947-162c-4d39-ba91-3c3016dda785",
"createdBy" : "3301ee0d-3da8-4229-ab79-c19a35ee637d",
"createdAt" : "2025-07-21T15:50:46.804678Z",
"updatedAt" : "2025-07-21T15:50:46.804678Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "c1437550-c4fa-46ad-97cc-cc611b13f7d9",
"resourceTypeId" : "ef7760be-e890-4629-b352-c696833afd9c"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 55 Admin - c1437550-c4fa-46ad-97cc-cc611b13f7d9"
}
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/a8c0c781-b19d-4871-8673-a14745848850' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ6N2NaWHhhdTlsdXYzMHV5bWc2dk1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFiMWNiODdjLTZmMTItNGUwZS1iODQ1LWMwMzRhYWE1NzJhMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NiwiZXhwIjoxNzUzMTE2NjQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZmRkNGU2YWYtZjZjMC00MWNiLWIzNTgtY2YxOWNkNzhhMWE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EqVYREpXImQTN2bpvOsQgz2OSCVT97jxfQ2MpNwKaBgROQTqUE8cq6ygAPQB3YR73FPWJERHtEReEcAMb_lEL1jbvXSibr99xD6q7FPSQMU8OZpVXy1oOebvCelvxmrzp9Z4SF6xJxhNOq15BA3Tmj1EREicAUtIdGT-DbkUgYLBjgrsNgfLe-vvP_eTcqcWR6KZIwaF0yb3w_E3t1iAQRToPIYu4JAQY5pUSXjZLIMNL_E_fpyZFBL1UMFPEJM-J6f5oLp0rF2X2PSZPnhJvGWhTL5M3Lnmt4oAT5WSeONjjHx3m6_od1xSm9vEs1n8rqCjnH9_us9440lrRvP_Eg'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJSd3hCaE1ibjFfR2tnZTJsSkwza2hBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBmM2NjZTYxLTZlYzctNDgyMC1iZjBlLTJiMzAxM2E0NjMwMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NywiZXhwIjoxNzUzMTE2NjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjI3YmJkNzUtZGUwZS00M2JhLWJjODAtMTcwNTc3MmVhNjZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.F5AJGNETG7Q2iWBzQQ3TDIO24g2jH6elDImsqshxCjSBt_K_amYVd6IUtf56NOIzMGqj-rvrhZ9bBohbhwYXMB_raXjCG5yRocAM23UQzI-9VF1btTIdbh78g1cef8N-o2_F-xi6HKoXOexoycR7ZwNJSpKp68XmEvHkXO14WqbyvZHhAwXC6jskZOdLynm13xeBni6Xt7sMOtF1DWPKpUDLNrw0SRYvxkS6DwnPpuKTP8NFWW0Je2sE94kOe0he4znLCDcvRE5hLiB3waheWsNLSwpSgK6A-CJqR42TF8yCu2duA5xQU0aHTckNKj4W9__Ygnou8cJ2ZE3otPsG3w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 990
[ {
"id" : "0aed3682-ede5-4582-a08c-63e72589ff9c",
"identityId" : "02ecdb1a-4827-4db9-9452-893faddbfb78",
"standardRoleId" : "6a28829e-d9a5-4395-91f0-8cf3ba4724af",
"createdBy" : "837c6e6b-44c1-4635-b2f8-5df8fac9b0b2",
"createdAt" : "2025-07-21T15:50:46.501339Z",
"updatedAt" : "2025-07-21T15:50:46.501339Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 51 Admin - c873eceb-8556-4043-bc9d-7588ede20a18 to identity 02ecdb1a-4827-4db9-9452-893faddbfb78"
}, {
"id" : "b7a21f17-9284-49b0-b987-4be844cfa4a6",
"identityId" : "be30a9d5-87d8-4ec2-95ed-0b8f36ed6b85",
"standardRoleId" : "ccbb2e59-e199-4894-93e3-afb19b12b45d",
"createdBy" : "8b38406e-1916-4c89-82fe-7a006446b1e0",
"createdAt" : "2025-07-21T15:50:47.328447Z",
"updatedAt" : "2025-07-21T15:50:47.328447Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - eae6616f-2af2-4c0d-8190-3955bd8bee90 to identity be30a9d5-87d8-4ec2-95ed-0b8f36ed6b85"
} ]
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/d658223f-9aa4-4c2e-95af-a052544b38a3' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJmOW05MWlSNXlha29Gd3NWZWx1U3lnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVkODRkOTk4LWNlMmYtNDMxNC04MmJmLWQ2Yzg1MWE0NGU2OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NywiZXhwIjoxNzUzMTE2NjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTY4Y2FmNjktMGIzYy00NjUzLTg5MjYtMTNmN2M1ZTAwZDJjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Iz-oxEHJ5HK7tDty4EoQdEdZCea5v27Y_cOZfVxdgNC3OGYZRi3ccjWg8XI-QwUuJ5CKSHhWsEpFXJN8lbi6d0sM6VyaS5xKopZrevcf768YQww_W3VAkhY6nb3yM9wU-eFYdjurHR4zc23vHaFnZSadmSt_BMVPbVFMa8EWsZ3z8aCk3w9cio6iuo77F1kBLsuHb3ePGAbjvyG6fmJiFbW3br04jeBBqAbq3kfnO0GiSe8hNv4TpYY10nkRiwQElisXwwHvhW47eaYhflfICw16pvoz5tZjk2CpATAOyXeCwAN6fDriInsTEWQM2Dn267dPNCjYFzNpv5ajTItN_g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "d658223f-9aa4-4c2e-95af-a052544b38a3",
"identityId" : "f7ad57a0-2459-4026-8100-be154dd623f4",
"standardRoleId" : "f956c099-b51e-433d-9c57-32d53d91eecf",
"createdBy" : "87546aec-5288-413b-b76b-d5efdd9ae87f",
"createdAt" : "2025-07-21T15:50:47.696905Z",
"updatedAt" : "2025-07-21T15:50:47.696905Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 63 Admin - cb949bce-7714-49ab-9bd4-f462ae6fdec4 to identity f7ad57a0-2459-4026-8100-be154dd623f4"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJfbW5iTHRIV0w1SWotRm1Vb0JlSWxBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhiMzg0MDZlLTE5MTYtNGM4OS04MmZlLTdhMDA2NDQ2YjFlMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NywiZXhwIjoxNzUzMTE2NjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2U4NmY3ZDMtNzczMi00OTMzLTkzZmUtYTM3OTBmNThkYzI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ3fSx7XCJpZFwiOlwiODNjYzA5ZWMtYjZlZS00Nzk1LWIxNjQtNjQzNzY0YWFmZDI0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.JVr25Owgw47DYAr8K4I_ygT2i7fXN34nQZTckbwjq86CCU67Zr7cb0rD2QSSl8jLnJ9jTo7ZUja7KyR0lKdSlo0SHX4VElxPmv3TpLbHWuEcUsb73-w4gIfvO6A6tHxlPbnrZFoj_tfM7vNtzAryvoqU4U5q3flMrqAd4kXNH7VM5lXylSBcuBYqgsXxuRxE2CTxcd4w27dCu_Dow7_p7s93r9smNC5FmHleAkCh_E5gflNoUYW5AScbjHivkFJuo5DXoGJKsaun1hryKEs60V1wP-xRcZX_NfhJiNmhvrjkXAcurSQlc-fP3MZGnCg7vNowLZh4oj-FwIN0xbJB0A' \
-d '{"standardRoleId":"ccbb2e59-e199-4894-93e3-afb19b12b45d","identityId":"be30a9d5-87d8-4ec2-95ed-0b8f36ed6b85"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "b7a21f17-9284-49b0-b987-4be844cfa4a6",
"identityId" : "be30a9d5-87d8-4ec2-95ed-0b8f36ed6b85",
"standardRoleId" : "ccbb2e59-e199-4894-93e3-afb19b12b45d",
"createdBy" : "8b38406e-1916-4c89-82fe-7a006446b1e0",
"createdAt" : "2025-07-21T15:50:47.328447Z",
"updatedAt" : "2025-07-21T15:50:47.328447Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - eae6616f-2af2-4c0d-8190-3955bd8bee90 to identity be30a9d5-87d8-4ec2-95ed-0b8f36ed6b85"
}
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/7b8941b9-2673-4f4f-9cbe-ce2abc0e75aa' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJpLTQzQTgybHRVa1RwNnJiNng4NG5BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBmNWM5Y2UyLTcyMTMtNGMwMi1iMzMzLTNjMDNkNjczNGVmOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NywiZXhwIjoxNzUzMTE2NjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjI0YzE4YzQtOWUxMi00NDZhLWI3ZWItZmE1YmFiODY1ZmU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.cE7LDyeQbbseE9YSRmG5WHU4BBTMIt0Npp-u_r_CYKxJzy08Dj9TTWpmOten0Sgd37vzdnn3wXqiWz5nn1R5odImyrlvfDmSwiIsSumjecapNZ-Yvq_nn7wcqD0a94Kjszh2ywvRla8eyo0CJLV5TavUR0INTcjfOnhMveoQghGqQkBpSnTM1NjUqQ5E6Vs7lEbO9x49kO-zbRohxvQNBE4ePJNgdylPa6HcHmFbnqPdmMsNj6qPjjVvSlL1a4iC0tjs6iQUcOCD2jCb632d5Sh-DPLrk08wTcVTrDVBErgW1hg56QxVkygLl29cdutFrGlY5eV_j-KoifqgvZHOgw'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJHZWVDZnNibEtVcWJQRzZ2ODc4LVd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFlZmVhNjM1LTJhYmItNDYzYS1hZjkwLThjNzg0Y2FhNWRjYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0OCwiZXhwIjoxNzUzMTE2NjQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTg2ZGU2YzQtMDdhMi00MTg5LTk1NjAtMzU0ZjEyY2U2MDcwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.FCzAhByt3NFONjzCYwbr2orJSHkqxltaPuo3zJ9LC8UI40din5KZdwDAKu-vPeCgFRd-7RQ7tNlBdySUuARlN2_CUp2M_Ezcfz5VF4p5fV35kwtJgP71wYjQbzEwqlhbNGViojW0qeazMjciIyzcUTjOPGFfINHLIeh3Cj3PYV3u3EdvR5JNX9yVS3u9b_0y85TYFNWbToAl66A2YhOGe_NYCn-7Pm5RFz5s9zJ3KWS2uaJHZxvGRqgMg2IE5puEsjsGu2k6jtxT5wkWIHO3wuDpFBtELOi4CPPndsKfPQIZFhKF9NPrOx2NzSeLtG9afwF2fnhkh3PiBrF9rWZ_8A'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1022
[ {
"id" : "4343b8a4-0a50-4fd6-a65d-c4b4dd252b4e",
"resourceTypeId" : "5b7b4a55-8f4a-4682-b790-1405cd341a53",
"authorizationStrategyName" : "Admin",
"createdBy" : "a861b807-5fe3-43bc-942b-1f8ebe7fc186",
"createdAt" : "2025-07-21T15:50:47.777439Z",
"updatedAt" : "2025-07-21T15:50:47.777439Z",
"_title" : "Test Type 65 Admin"
}, {
"id" : "2737b475-5748-44e4-a2fd-4d9ec287a0e2",
"resourceTypeId" : "d6e48001-11af-4a56-a651-4b3a71acf560",
"authorizationStrategyName" : "Admin",
"createdBy" : "e62f536b-69d2-4bb1-a4f6-8e292e5148a7",
"createdAt" : "2025-07-21T15:50:47.687712Z",
"updatedAt" : "2025-07-21T15:50:47.687712Z",
"_title" : "Test Type 63 Admin"
}, {
"id" : "eda543c6-5748-4cd2-8b48-465b3b4a26d8",
"resourceTypeId" : "962209bf-e5a7-4ffc-8f11-966231db97b1",
"authorizationStrategyName" : "Admin",
"createdBy" : "fb09eec6-e401-41df-a268-6ae2c3dfaa5d",
"createdAt" : "2025-07-21T15:50:46.667485Z",
"updatedAt" : "2025-07-21T15:50:46.667485Z",
"_title" : "Test Type 53 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/c13fc918-8eb0-470a-b8dc-ba2313f8f60c' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ1UGFGY28tdi04QnNLLTI4clk4TXBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZiNmY4YzljLWFmY2YtNDRmZC04NTJhLWFkNzRiMDczMWY2MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0OCwiZXhwIjoxNzUzMTE2NjQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzViMGI3ODctMDBkZC00MDAwLTkxNjItZWM2YzIzYWNlOTcyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f-HVWlJk2kERIkfP9p_Dra-HOA_o-eqP8NJL72rQNVilBpi9sw8y-ekY0scFcKu7XCYMljaT3eNNcE2MoHhhfD_X98TYEoEm1JzEqEedW_6Kn08Zc91IhEaYARwUsYroPb6BtI4SLJW65DNAwe8d59Q3_i7dGQ2NtOQnZmXHU4RHHOtuqmEe1mKVv-dON2o0elnm6zDUY1B6LBF5NlIVdXpfIjuxJv0pI5YFmtnLe0JcnEKmjoXd8e8l46xZ28p51ndMOKyiWUo0c60r9ghPVtnzO8eqGM1rw9Uq69wezHLDUTrigzNyhC0CdlddSr3DNACaezxuZSxPNUwddpe8aw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 338
{
"id" : "c13fc918-8eb0-470a-b8dc-ba2313f8f60c",
"resourceTypeId" : "200f96a1-6c6c-4677-864e-64a3ef6c76bf",
"authorizationStrategyName" : "Admin",
"createdBy" : "0d30f889-2261-48df-b3e1-93e83d79aa9a",
"createdAt" : "2025-07-21T15:50:47.998895Z",
"updatedAt" : "2025-07-21T15:50:47.998895Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJ2RG5mcXZ6SnhRaDBGRFo3Xzd2NnRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlmNGZhMjA3LTA2ZmUtNGMzNC05MGUwLTQ0ZDUxYWQwNGNhYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0NywiZXhwIjoxNzUzMTE2NjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjVhMjM0NmIzLTIyYjktNDIyNS1iZGE4LWY2NGZkNDU3ZDAwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NX0se1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcImU2YjJjMmNhLThhYzYtNDI0Mi05ZDM2LTY4YzY1MTQwOWNkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzA0NH0se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjBiNmRkMzMtZWQ2YS00MDcyLWE5N2EtZWFmMjk3YTg1NWE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ3fSx7XCJpZFwiOlwiYTIyMDZhMTEtYjFkOS00MDVmLTg3MDUtYWUzNWMxYTAwMjZiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ccm-JEwnzLVHo8QM0ro9OAK4E_MNzGcScx0YiNWzq6k1X3OWh1_VSLsiXLcCBj1Achd7qd37qYAllt731crndChvqGcxOY2tcoZJPTaPXwWI3dNnfv_mRL99Hx176iD4jAHYoN00xdNwcWf7sJLjUJCOs_SOYnzi3lu0qS9mcdSPxBBk0BE1nT4SaUeaYSOF6P-uEDqsYlGUhj2QnRc2Mxs5W736v3y2RFpy6WOFlL2NObqNhn3plcGtTE8VJ-Wld_jqZPWYit3DYjR8iswfXLXqzIPQjBGqLkdOUMlB-Gd5jkR_fucjv65epQfOwaAS9KeFWpvNhS3s62ucv-mKcA' \
-d '{"resourceTypeId":"8719bb60-6e71-414e-9b25-62a96c6e13f0","authorizationStrategy":"Admin"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 335
{
"id" : "2fd48076-2827-4f7d-a4ae-61709cbce4d8",
"resourceTypeId" : "8719bb60-6e71-414e-9b25-62a96c6e13f0",
"authorizationStrategyName" : "Admin",
"createdBy" : "9f4fa207-06fe-4c34-90e0-44d51ad04caa",
"createdAt" : "2025-07-21T15:50:47.910421Z",
"updatedAt" : "2025-07-21T15:50:47.910421Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJOOTNuT1M0Qkp4bmc1dWdjZUtUa0VRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJjNDVlNDc3LWQ3MGItNDRlNC04OWI0LTYwM2I4ZDBkYTc4YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzAzOCwiZXhwIjoxNzUzMTE2NjM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWRlNzQ2NmMtZDEwNS00YTEzLTkwY2YtNTQ2NDgzMDU5MWJjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDM4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QS2UAMq7A-JF3K3VZvXMcuYJGNe2_Sps4fC4s4LmmwxLhCslzdj4cgZHvyKsM26RHSLJI4dV883KTspVG8GH8ZCvqbaMIT1t3eCXjEgsoheIQAJ45Q6yd2B6etE2nWvCCHnEVDHf5prIg-DMTr-ggF4a5KTgt5Exc5sO9t6T7sRntM3MoqS97mR4Zaf3Yr27QFVWoLA6W656rsivMcQA06tvkc6Fb81vg9JfdyOX7QUFDk15c72qc1nxTsKTCeNv2KQtjlqEvnRYJKEtNBy07YkGa4fK3FXb-x62OBp5iGFQBfgctHIQYxZJ0E1UC21TNbPcVwzCWjnYypPuMC8z-g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1580
[ {
"id" : "dd77c26f-fee0-43ac-8987-bdba1ae61f2e",
"resourceActionId" : "778adaee-f32f-4b85-ad63-4597228dae67",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : true,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:13.632527Z",
"updatedAt" : "2025-07-21T15:50:13.632527Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Read Network Limit in Admin Standard Roles"
}, {
"id" : "5c6f4589-4da9-4e7d-b468-07cebcfb6437",
"resourceActionId" : "de981a53-7a80-415e-8243-c622db0ac816",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : false,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:13.676939Z",
"updatedAt" : "2025-07-21T15:50:13.693312Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Create Browzer App in Admin Standard Roles"
}, {
"id" : "988f113f-e719-4ebb-b9a5-ad2b8e961c02",
"resourceActionId" : "6f997f0b-5098-46ff-b067-992b76c36b75",
"authorizationStrategyName" : "Read-Only",
"includeWhenAbove" : true,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-07-21T15:50:14.346782Z",
"updatedAt" : "2025-07-21T15:50:14.346782Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Read Organization OIDC Public Client Mapping in Read-Only Standard Roles"
} ]
Get Action Inclusion
GET /action-inclusions/{id}
Authorization
This endpoint requires read
action on the action-inclusion
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
authorizationStrategyName |
String |
true |
Must not be null. |
includeWhenAbove |
Boolean |
true |
|
includeWhenAt |
Boolean |
true |
|
includeWhenBelow |
Boolean |
true |
|
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions/63a1922b-fd7d-474d-86e4-c905be059f09' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJRbjc4dVRpMG90enU4aEFDT0VpaHZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjViZWNjYmViLWIyZWMtNGQ5MC05YjBmLWMyNmI5MmU2MmMxMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MCwiZXhwIjoxNzUzMTE2NjQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTQzZDQwZDUtNTU0Mi00Y2ZlLTliZmMtZWVmM2IwMzY0MWM1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PgEObrA5CiynCd-uIHf--epIxbQESRErF1AiJDZ8_xsY15GHS_Ih-6VWeK4s1zQugufGthWL2sA2yeEaUR-a32hnz7zhNi-8SDSvSoUzW5cBKjocnxxvfQcuJhiYNxHLWRRSc3zdV8ZYBNP4UBpf7eEIJT60g5AN4oynsp-Q2EesM9vU3At0_vJmWo-ICvQ6zUWxvxIEsODC5AdmhGwL_Xom2QBtjrthat2vApi3fGZMnP4S6_AFg1KtPl49aniyhiqEQg_FSGkLBjqy5PiN3J5lDBBxITJhTeY0poqudJRnvloghk420kRYZF9NYcP7gXiVliRWkLdA6ISqM4Hj2w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "63a1922b-fd7d-474d-86e4-c905be059f09",
"resourceActionId" : "30b58384-c5a4-4dc3-a006-2c04cd3a2b6d",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "e8cb7cb3-3584-4f4b-a0c6-e5029511d906",
"createdAt" : "2025-07-21T15:50:39.986418Z",
"updatedAt" : "2025-07-21T15:50:39.986418Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJpNUlrWENUcEU4M2o4QTNLeWRNV253IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM4OWVlYTBjLTMwMDYtNGNlMS04MGU0LWI3Yzc3YWZmNjFlNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MCwiZXhwIjoxNzUzMTE2NjQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzhiZDU2ZjMtYWJmZi00NmIzLWI5MTEtZmQ3ZDMyNWE0MGI1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQwfSx7XCJpZFwiOlwiNGI5M2RkNmEtMmNhZi00NWQzLTg3ZTQtZjUyODc4MDZmNzZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.plClG390QKVgi1bzBhqZLIrXsFxGeVWVlrIqoOaeKIN9Z7lsKz9ZPcOs8aQbc-RHLV7270UbF2gtkuJk-zA88SLW6ZUbsKhgz0B18bGtdLrAunGNF19-_J-zuXF5YMRQGqXJjTgbm0-oiCxBLHersGCr9OGQPv30RW-hkrNzSdjb0745UKrOnpw0roXavD5h7qpI81qf-kdZ9VXGigavd8dNBtmBUR257JCRSJ2zPbmGweNRPmW8l10QC46f9DVzXoIS0K-thCvqGY5F_xEKFZeVI2viVD-xikMZT3Lh-kdWS_UvmHQ0fJlolhrGnig3GblFlKeJk4EA9HCjnOwz_Q' \
-d '{"resourceActionId":"d97b10aa-7064-47b6-b69a-e9ea7dce05fe","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 526
[ {
"id" : "7584d58c-b0d4-43f6-aabd-08651045d827",
"resourceActionId" : "d97b10aa-7064-47b6-b69a-e9ea7dce05fe",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "c89eea0c-3006-4ce1-80e4-b7c77aff61e5",
"createdAt" : "2025-07-21T15:50:40.696031Z",
"updatedAt" : "2025-07-21T15:50:40.696031Z",
"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/27feab49-a834-4bce-be7a-f7fb21eed6a1' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjI3YjNlZWJlLTYzOGUtNDM4MS04ZjY4LTdlOGJiODY1MzNkYSJ9.eyJqdGkiOiJkbm5sNlg4VGhBY3FwZVdLT1ZlNjFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI4MDUyOGExLTRlNGUtNDc3NS04MjBmLTVjZTAzZWFlNTViYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1MzExMzA0MCwiZXhwIjoxNzUzMTE2NjQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjQ5NWUyMDliLTA0MTgtNDAyNS05ZDdlLTYyZTQ1MTBhZmFhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcIjkzMzY1MzFkLTA3YTktNDUwNS05ZmIzLTYyYzk4MTA2Yjg2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImYyZDBjNTZhLTQ1NWUtNDA5MS04NTVlLTZmNDExMGZmMzViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH0se1wiaWRcIjpcIjYxNWYzNjRiLTQ2ZTItNDZmYS1iOWE5LWMxODIzNWI0NmE2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAyNX0se1wiaWRcIjpcIjI3NGExMjdkLTg0OWItNGQwYS1hNDBmLWI1YjUwZDNjYjNmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImM5Y2M2MmI0LThhMWMtNGVkZS1hMTA1LWI0NTQxYWM5NWE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcIjEzYWQ3MzM1LTlkNzQtNGYzMy04NDBhLTM3NDI0ZmNlYzAxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMX0se1wiaWRcIjpcImZmMDkyMmVhLWFmMDEtNDk5My1iNDdjLTY1NWQ4MjVjMGJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxM30se1wiaWRcIjpcIjAwOGM1YTY4LWExNTQtNDYyOC05MDc4LTdiNjFjODRlZTY1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMn0se1wiaWRcIjpcImQ2ZDg3YjFhLTA5NWEtNGQwMy05ZTI5LWZkM2E4MjgzMzQ4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1MzExMzAxMH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODFhZDg0NzktMDkxZC00NjQ4LTg0ZGMtMWNlY2QxNWQxZTdiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzUzMTEzMDQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.mKSt50Cs4YBx2rYGcyDmnzC-hSSFzjoYW4VHKbfh_0vWfbEsvspVEkmTuqy9Uju45zORMrvYwROu6swDKiob2Idke9VeeOTC70i7933XUKkTS6MxB08lqf8OOY7QTknBuzKrUgbtbcatBTsFCuM25j4M16GjMUEoFmLVPOv0h8jsQTB-yLX9_WPaIUTcia_xAoTCPKgW29IF28F83RlSpAeJ9xxVstz0PUuVzcozQJB17s9QsbzNBcb3oA17HFVLHt83pqEVtK-kgXzr2MdwIWMdUy9OynDdLaCtAHAaN4Y9sbVaeglP9l2Tsphr63PKCXfTqWUYGbdkL0xlqXv9JA'
Example response
HTTP/1.1 200 OK