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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJHYWV1RVp6R1RPVUZYYXVCYWlvcXVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkxYjU1OTMyLWI5ZDgtNDRjNS1iNWUxLTQwNDIzMjIzMWQ3MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg1OSwiZXhwIjoxNzQ1OTc2NDU5LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjJhMDg5MGRhLTYzMGItNGM2Zi1hZDZlLWZlOWZjMzg0MzgxM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg1OX1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMWEwYWUxYzUtY2YxMi00NTU1LWE3NzUtYjczNWRmYjhlOGFhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNzc3NDczZjItNWFiNy00NDMyLTg1OTQtZjRlNTE1NWE4MThjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM1fSx7XCJpZFwiOlwiYzQ0ZmVjYmEtYjE5ZC00OWRmLThmNDEtNjJlNDc1M2E1MmMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiMzM5NDZlZmUtZmU0Zi00MDhjLWI2NjAtYmNkYjEzNGNlZjczXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNzY2ZTNmMGEtYTdiMy00M2FiLTk3NzItZTRhNWQ3NTJiYzY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODQ4fSx7XCJpZFwiOlwiZmI4ZmY5NTgtMWNiOS00MDZjLWFkM2UtYTZlZTNiNjNkYmEwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM0fSx7XCJpZFwiOlwiYTEyYzNjMTMtMDgwYS00MjM1LTkxYjYtZTg3ZTZlOWFiODkxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiYTczMTA2NjQtNjVkNS00ZTFhLTkzZWYtNDcyMGNhYzljNzUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNTRjNGUzOTAtNTU0Ny00YTg0LWE0MWYtNTlkY2U4M2RiY2YzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM0fSx7XCJpZFwiOlwiNzc1MTU3ZjItNWNiNy00YWExLWE1MWItMDA5NTMxN2FiMWQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.YIahGZ9_08nDI84NpzUdmCBLDBTbdud8INj02THCRLOrmmZxh-HtIjHMbMeXpvPa2bKizf1v3FSt24qXpx5dS6R640VzzPIO8-eKP4kzrWaqUsA1L18SBU4xt7uMW9hVUeP2iapX14d-YXt6_Djss5wIS2J28Sf-x2yyq8AkW3fXhO3w8lW970CjXaydfnKlMefCJI4fcizax1bbKaGqWHOSHK7hJLsmUGgQCb6OI9g04zMeeyzjhPl7L99sr34STRQnW3qK-t52AAmCJ8wxbSUy_IcarCytGdBgcbfoo4hIdSsUblDa0e_5vLxdFUVNVBF0WhCfCU5ANQYL4HW2lA' \
-d '{"identityId":"26e9bb42-2b8c-43cc-b961-bfdf1228538a","audience":"io.netfoundry.test","claims":{}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1950
{
"token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJ2NFRlcVNVRDhlVUNJMmFETGNFaGF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI2ZTliYjQyLTJiOGMtNDNjYy1iOTYxLWJmZGYxMjI4NTM4YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTc0NTk3Mjg1OSwiZXhwIjoxNzQ1OTczMTU5LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImZhMDBiZWZkLTNkMjctNDVkNS1iNWQ4LTcxOTE2Njk3NDcyZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMWEwYWUxYzUtY2YxMi00NTU1LWE3NzUtYjczNWRmYjhlOGFhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNzc3NDczZjItNWFiNy00NDMyLTg1OTQtZjRlNTE1NWE4MThjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM1fSx7XCJpZFwiOlwiYzQ0ZmVjYmEtYjE5ZC00OWRmLThmNDEtNjJlNDc1M2E1MmMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiMzM5NDZlZmUtZmU0Zi00MDhjLWI2NjAtYmNkYjEzNGNlZjczXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNzY2ZTNmMGEtYTdiMy00M2FiLTk3NzItZTRhNWQ3NTJiYzY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODQ4fSx7XCJpZFwiOlwiZmI4ZmY5NTgtMWNiOS00MDZjLWFkM2UtYTZlZTNiNjNkYmEwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM0fSx7XCJpZFwiOlwiYTEyYzNjMTMtMDgwYS00MjM1LTkxYjYtZTg3ZTZlOWFiODkxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiYTczMTA2NjQtNjVkNS00ZTFhLTkzZWYtNDcyMGNhYzljNzUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNTRjNGUzOTAtNTU0Ny00YTg0LWE0MWYtNTlkY2U4M2RiY2YzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM0fSx7XCJpZFwiOlwiNzc1MTU3ZjItNWNiNy00YWExLWE1MWItMDA5NTMxN2FiMWQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZxYJ7P9sDuLoOykv_DeTlmOaNulWiKyyO627lKxIj3fQlbI_pzfmymjWKd_F6oqnzXLdMBQ5qWhXzECV3nvNy6Mv1zVc5ZwJpJXLXnBPpOnA27XgjZAcwHfDkyMVcwbme7-eOrpuDcuof3kL4B0M3O_DDnHeesP1BGyPf3bD9rHXtDgyxgDgJJ3NT8phkjj-DsRQP1jjAFOe_vPdvvjYbFxiFY67jFiiOulyJ2wbvudBzuiBH2ZCsEHu9Ewh51If85wur08MlHOsuA8D0amHwZ5JRi1613URMwOZG4Y7XD5iqZRCzRug_l2_Wx5K2mFxdGWdrZodeTzzGxXt5j5mBQ"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJrbEw5NUhGS3VoV25fZzlZSHItMXR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY1NGZiZWIwLTNmNDMtNGNiMy05ZGFlLTFlNWE0OTQ3OWIwYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MiwiZXhwIjoxNzQ1OTc2NDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTE0ZTBiMDctYWY3Ny00YWRjLWE2NmItZDcwNmI5MWMwYzEzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.XynlNbrh7aHRDPc7Kq2y5rPpbhn_4oZPMNHUe0lftHDkeZTmTzDWBbSkaulNJiK-JzXVwszR5mx473BDztcafZsNnyoq2zGDwX679yKpad1v2bGSYAgBEsbf9uiU8yBDc90gvDS_QVLz8Hz5LO28IWSpTi0FUyUMBDMPc0vqrZLv4AtZRCf1rKGkUUrvhRwZUw4Ypfx-ypaZZ3PkSPTQkIpyIsaacyTExmorKr7LV3KRfqqocv71WynZ1y_nwFe5MA7mE9_UZxLqGHK-pMBHT39E85Dozm_Igk5tuDM-346rwgA79l6sX44e5Jjqg_nkxli96ujf8FMiLuocBkiTdg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 874
[ {
"id" : "cdab2379-e19a-4e02-a9f8-f241faa5b9bf",
"name" : "Test Domain 9",
"code" : "test.domain.9",
"createdBy" : "ea686ae6-f34d-4518-bba1-836034dda0b9",
"createdAt" : "2025-04-30T00:27:33.357804Z",
"updatedAt" : "2025-04-30T00:27:33.357804Z",
"_title" : "Test Domain 9"
}, {
"id" : "a5e9c7b1-3a74-49b6-aabf-c61a2b628a46",
"name" : "Management",
"code" : "io.netfoundry.management",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:15.274366Z",
"updatedAt" : "2025-04-30T00:27:15.274366Z",
"_title" : "Management"
}, {
"id" : "1cfc991a-b0d4-4fb5-a7a7-4629b026b147",
"name" : "Test Domain 5",
"code" : "test.domain.5",
"createdBy" : "3a84a5cc-0ce7-4205-9ef5-8bbd3f3f5dd3",
"createdAt" : "2025-04-30T00:27:33.249010Z",
"updatedAt" : "2025-04-30T00:27:33.249010Z",
"_title" : "Test Domain 5"
} ]
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/285f58d0-f30a-4e24-af22-d328200f039f' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiIzbTU2WVRCQ1B6ZnBDM2ZjREpOVHdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFmOTE5Y2UzLTI0ZTAtNGFmZS1iY2I4LTQ4N2Q3MTViYzYzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MiwiZXhwIjoxNzQ1OTc2NDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTk3YzIwZDctN2YwZi00MWE4LTllNjAtZGIyNTFjYzQ1NjQ0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EmQwkogq6vIgBqc9azAQ9hOmixvCMVW_4a6Cv9jloWDDsUX31y-5zFZMHVux_Y2eGOUi8cGkoOBNt5OMgI8PlZM--vi5ziMPe4aECj8HpgEhxIYrnKshWlYmusnEz49HACucmzau5mnF9NBfsxmTr0sbyH2U4Q6kcPXn2Bc3efiUi_ffgV3NE1cvxq7nit6D6ODxj94Sa8y0VN99fUs36tPxYA5bxP5fI0SIHX7Eb-PqyWgtUy33AztgfBI3IOrr0kjyBnnROG-L_7mbjt0vIJdhtLpC9GUZc6_um3HUxkOYRSFAMlyX3g-42NEhKGzbqNoyL5Jl255G_1Seu1ZpOQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 288
{
"id" : "285f58d0-f30a-4e24-af22-d328200f039f",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "c1bd70ca-e500-4328-b143-e134c059cf43",
"createdAt" : "2025-04-30T00:27:28.809270Z",
"updatedAt" : "2025-04-30T00:27:28.809270Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJJZjhkZVM1bUZVUzkwMDVhRmhlSGhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJlMzQwZWIzLTk4NTQtNDhiOS1iZTFkLTE4YjZlZmE0NmQ2YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MiwiZXhwIjoxNzQ1OTc2NDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmMzMGUyMTEtOTgzZi00ZjU4LWEwNDgtNDBmYzQyN2RlZWFhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GyTs9LdWBQKzJANQ5zJXJOAxrH-ZlXzj8Ze5ycgXA6UcngIr2CfqRYKfeMr_HVjnVyl1oPSh8AEStlKyyNTgdJGGk0sobgIGDYCSgO8IhH9_xdA96M5ItW5ge5UCOwqey3sN9DSmruTJKAhwPWvb04udcEqgPOfcccWwdDf027QXydhaTMa08DbHZAIopk7c8WyXMXpDBJfEh3MMVkgqQQH0W4OleMFCsXShVmAZjGJ2SF8J-uyrzho-_qF8RtWu9GHkpKtNhs7obsYolwCv2H1E8GK-708ULDz9yjpXYXdjx_I-_kPAR32iDIvGpvbZIdLDyonX6fFeR0sAeS8bgw'
Example response
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 288
{
"id" : "285f58d0-f30a-4e24-af22-d328200f039f",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "c1bd70ca-e500-4328-b143-e134c059cf43",
"createdAt" : "2025-04-30T00:27:28.809270Z",
"updatedAt" : "2025-04-30T00:27:28.809270Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJHT3gxTThCcFpaYzB3T1FxUkFSMW9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhkZDZiNWE5LTkzMzMtNDk1ZC04YTFhLWQzNWFjZGFjZGI5MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MiwiZXhwIjoxNzQ1OTc2NDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTZmMzIxODgtOWZiNy00Nzc1LTk0M2QtMGMyZDEwOWFkOWYwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DvSwJqpDgZ1ierI-7r7RLZrp3hoD3KOHnpHCrpTLsChFckRsqQzXHs2XMydYssKT8cPAvNaw9DLmwWDNdNAJYS3GTKJewUhBEa9pubdoXTFFYqf4WMbBgpmJlZCO_tOQwuTDXWNi-EhSJiIhYYIJJRFEyRswkns6X222_n9cTYXTbT-_dbufg9IeMG4dNkDdkwDFgQ5sLP1fUlqdyeL_qRZEAxgA4l_M0pY1ODE5i8ypmsTXPvNKqBz9xbdsajAnVi0SXvKZCBpF9s1Y58mz6LueHA_zbsgELS6c1LZa_fsxg2HMQd__kpkFfcdsBQiYBJWzph7H6nCxTnDQVRHppA' \
-d '{"name":"Other Test Domain","code":"other.test.domain"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 299
{
"id" : "2f7ad347-44ab-40e4-9e65-319ff4e9e8fc",
"name" : "Other Test Domain",
"code" : "other.test.domain",
"createdBy" : "8dd6b5a9-9333-495d-8a1a-d35acdacdb90",
"createdAt" : "2025-04-30T00:27:42.903476Z",
"updatedAt" : "2025-04-30T00:27:42.903476Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJFRmV4dWh1UGpLYldoaVVIZGE2UWZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEyOTk0OWYyLTVmNjUtNDdjOC04MmFmLTc3YWMzZDIyNTNjZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NSwiZXhwIjoxNzQ1OTc2NDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWMwMWM0YTMtMmRmMi00MTdlLTlhNTAtZGFiYTk1YTI2NjAwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.aC40k7pNCLp4s-xiKW55k_LmEfSCEeEWWZ5k2x6aycxYRemC1qywyc5atS64A_AfIve08_F5P5QB49N1SamxEOWzT0cq51p59X2l16w7QG6LeKUJB4S0MQgRa270Dxd8ASTLCwR3_xH96aWZ_CmSt-7SnukzBKQfYiF8Vl1Of22CzChQVgYtjhwHUr4qL2u5gZlW4gJ46_gaieaMcrplaIHypnw7gbwz4jVtYWpCIKEkpN-F_xvCwIY7Tz5dukbMXdFtGftuPxQ6bAMmS2Meb6xa0X8A31dkDcFTDa_bXPuwzsSZ-qPznQnWPsJT5dpB8Z223Qb7rnYARCLZNeuFjw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1391
[ {
"id" : "fd0ab465-e5c0-4093-9417-e50828adfbb9",
"domainId" : "05d6eaff-0754-4f96-805c-cfab7d1dea19",
"name" : "Service",
"code" : "service",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:12.037024Z",
"updatedAt" : "2025-04-30T00:27:12.037024Z",
"parentId" : "1db29304-babb-48e4-be47-c253728d5e77",
"root" : false,
"depth" : 2,
"childrenIds" : [ ],
"_title" : "Service"
}, {
"id" : "4409b6ee-cfe0-464d-924c-1e246a0f32c9",
"domainId" : "05d6eaff-0754-4f96-805c-cfab7d1dea19",
"name" : "Attribute Mapping Config",
"code" : "attribute-mapping-config",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.917181Z",
"updatedAt" : "2025-04-30T00:27:16.917181Z",
"parentId" : "b92db1c8-1051-4b9c-914f-a081381c0b87",
"root" : false,
"depth" : 3,
"childrenIds" : [ ],
"_title" : "Attribute Mapping Config"
}, {
"id" : "f2f8b240-06a9-4204-a181-9aa504ea76f1",
"domainId" : "3828879d-c89d-4af4-8040-9409e02b0b84",
"name" : "Service Identity",
"code" : "service-identity",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:11.970222Z",
"updatedAt" : "2025-04-30T00:27:11.970222Z",
"parentId" : "02d19c28-245f-4a44-9470-470f7a8126f0",
"root" : false,
"depth" : 1,
"childrenIds" : [ ],
"_title" : "Service Identity"
} ]
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/07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJlUWV3RExVd0RRWXloanFTeGE5TFNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ1NmZlMGMxLTBmYmYtNGNmNS04OTc1LThmNDE0ZjdhMWRjZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NSwiZXhwIjoxNzQ1OTc2NDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWViZTMxMjAtMGZmZC00OWIxLTk0YzgtNDA4OGY5ZTU3MDM1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.gAv0hfObf1G1VmqnSW1V7stc5g_ach4IFWFIIOh1GYrm2AZWrq1k641BhGwTD0CUvDHTeY7HrTOshcdvKHPOwKzJs21vXkqZTRO8Bk10cQLHTmOj85vHeyVVXNA5vWtHpMnEW5euNQQhfltoeqNmZNn7zvLQTiCun2sq_66JRgmhO-qMj8OwQJR0Rp0eIeL4P1O5ELdT8iIXxZWwkLVwXP4P2yqT2dqA9HC5zfrxZzjdNDWkMySINDBGh9Vd3c_pWN-MSxhT9HmwHHDLsj0zZWJVdBvyuSlLrd8j5lcO74txU5u2PxVA2ycKjrbXxXsRzELH5PqwXjaZZH61wxZ4zQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 406
{
"id" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c",
"domainId" : "285f58d0-f30a-4e24-af22-d328200f039f",
"name" : "Test Type",
"code" : "test-type",
"createdBy" : "c4615c2e-3f26-443b-a34e-a091234926f5",
"createdAt" : "2025-04-30T00:27:28.917052Z",
"updatedAt" : "2025-04-30T00:27:28.917052Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJ6c0lnVEpBVjJSbTlRTHM5QVpHSVdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRmMDkwODQxLTczOGQtNGI2Ny1iZDg2LWNkNWU3OWU3NTg0ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NSwiZXhwIjoxNzQ1OTc2NDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2JmZjJiNWQtNTk4Mi00NzViLThhY2ItMTg0MDM3YmI0M2RhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY1fSx7XCJpZFwiOlwiMmQyNDhhYTAtMGFhMC00NDQ4LWE0Y2EtZjU4ZTgzYjgzNjI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY1fSx7XCJpZFwiOlwiYzRjNTRmNTMtMGE1NS00YzE5LWJhNWMtMDc5MmRmZjk0OGRhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.gUzv5R9Pxp9fWZ0z5kxmouYJfm5lhte20mX8s18_MiTT8by7QfJjn7hQeW4tqi8f_3GxFqHcZ9sytnLg5GGxgGFX4duXvAVyOAG3l9HsU0IsEVfija4X7QhvyGG7GQXoPLd-meoJ_VliFAzGHBldg6qEE9HYUxDDaIsASqx_Mop6K3mis1OTR4oOGTUtCR5mKYy5t4EWDMfLiONYn3DNyELzeLjWItIv3UssaSJ3_TLYfKD2HDoAcuwhos6psKC2QuBZx9URVV5FXWRmo9TxMftDbf7fuX5icXVBF9q5NIgNFqPVXx5rcZw-uaBpU9Hj8Zj3wmn8AFjOjPbO3vad9Q' \
-d '{"domainId":"285f58d0-f30a-4e24-af22-d328200f039f","parentId":"07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c","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" : "0009d5c1-06bf-49de-9f90-e8da0d10bc82",
"domainId" : "285f58d0-f30a-4e24-af22-d328200f039f",
"name" : "Another Test Type",
"code" : "anoter-test-type",
"createdBy" : "df090841-738d-4b67-bd86-cd5e79e7584f",
"createdAt" : "2025-04-30T00:27:45.810636Z",
"updatedAt" : "2025-04-30T00:27:45.810636Z",
"parentId" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJZOXcxdG9SWGR6WF9PbHBtNXZ1R3lRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU5YjJjNzk0LTgxOTYtNDc0Mi1iNDA2LWZmMWRkMWI0MTZhNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NSwiZXhwIjoxNzQ1OTc2NDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGZkYjExNDQtYmM3NS00MmEyLWI0MDQtYjc0ZWMwMjFiMWUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GXfpWZYUxRc_UuY5aG2IjSshZjpW_VgAEmiFxqHcdbRty3eSAOtXQwif11QDwZNKHANLukbA2CiCEhXORU1fLmyMl7p5Y4yJ25JeX1YEh1Vsui0EqicHfpMUyi3xvzaCqHxPlocrcoji6RAa9_UmH2qUdMewXJe5scyk4RuSBk-56t_Rzs2Y22NDLItfbnlJoGjSDyIKuphserC9Qipb1OisnHpWYvuHTnfkaRtTyoR9hQ7VC0nJXCVwY3QKf-s6cZGqbz_vFklco7YMLILiJCR4dI0l4KHLkJf00ERP-Oh83CZHB1kgfl9JLDW8Z13OG_XOUVAkrlmjUSsFTQqw9w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1101
[ {
"id" : "f12b8d3c-11ed-4c17-88de-39220c93168b",
"resourceTypeId" : "f0ff9d8f-9249-4087-a80d-1e60fb457b63",
"name" : "Read",
"code" : "read",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:14.224555Z",
"updatedAt" : "2025-04-30T00:27:14.224555Z",
"standardAction" : true,
"_title" : "Read Posture Check"
}, {
"id" : "2b927284-a92a-4eb7-b0a4-bf8c4e730b8b",
"resourceTypeId" : "dc4efb29-74cf-4043-8802-ed602343b9a2",
"name" : "Create",
"code" : "create",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:13.427009Z",
"updatedAt" : "2025-04-30T00:27:13.427009Z",
"standardAction" : true,
"_title" : "Create Edge Router Policy"
}, {
"id" : "58aaf1d0-92e3-4c96-98e2-76a13578d100",
"resourceTypeId" : "a8a2e021-d840-4db7-9f7d-bbb956bfc904",
"name" : "Read",
"code" : "read",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.844307Z",
"updatedAt" : "2025-04-30T00:27:16.844307Z",
"standardAction" : true,
"_title" : "Read Execution"
} ]
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/e995e056-1781-4958-99e0-7e86aef022f0' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiIzU1RLczU1T3VYZFB3MHBVM1FtTWhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ2NmI1ZjQ2LTVkNGItNGJjOC1iMWIxLTc4OTczNDk0NjYwOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NSwiZXhwIjoxNzQ1OTc2NDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2FiYWIyMGEtMGQyNi00NTM5LTk2ODMtMjA0NDJlNDkwNDRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.O5XDz90ouQR27yfHeAfjO-fSyfwzNkmaY-POuY9JicYbB8IRMLSgREvwCKftu7KnM9cSfnWIxV1M0cmoKetBnepmhB5v_Jtd72dBJS9D0badNKq77XDE_bsF5hWIvQLezSmTmSAvaHaVmr-_samUOvnqrOWhkMBG7Nyu44G_ZMWvzrFXl6eVV8d10MsOaQ91lX8IWbpNIlGg0mk5day8tQnBQh8EK-Cq-Mvwyswd0clV_WMfaWOlc--9hkuqU4kMDoAH31Xlls6bkL7QhYfVsBZVZy_2PNj1M96D2iazBEVkNlPpEEosoC5l2EnjrUF-qVlT4RK-RXUCQ6BUS5DOYg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "e995e056-1781-4958-99e0-7e86aef022f0",
"resourceTypeId" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c",
"name" : "Test Action",
"code" : "test-action",
"createdBy" : "31ad0496-3200-4e2d-919f-206d9d29a524",
"createdAt" : "2025-04-30T00:27:28.962119Z",
"updatedAt" : "2025-04-30T00:27:28.962119Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJ3dGNFZWN3M2MzQlpZOW1ad21abGNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkwZDMwODBmLTExM2QtNGU3MS05YmFhLThhYWM4ZjE5MDY1MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NCwiZXhwIjoxNzQ1OTc2NDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWUxYjJmZDktMWU5Yi00NjFjLWJkNDktMDY4ZTQ1MDg0YjA5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fSx7XCJpZFwiOlwiMGNkNWYxNTEtYmI2Zi00ZjQ3LTkwMjAtMmE3ZTg5ZTI3NGMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.MrtCc-NpPIhPzdGyDInhw3e9Jal_QzG07PWMd8wfeeOSfCQEfLBDgHtTw9AdfCDDyzzhOsP17aYAwh1-5OH6oJsnNkSuTUY8ilXuBLh9LxorclYKyCq86beVLyx33FTM1c35Mky_fhjlZLRTnlgTrUo3GG0YvA1ll9LKbcx2lWYjYyw7HDS5243fT5CbLCuNKOI4KHUKeaN17ESZ4tv4_83zFnVWohfnaWbmG5wUeJwKGzhIG3KxIaLar6d1vvY4gS9YWThYy6e0kBjuLW3oLt2Wo-Yj4bip-fCOHnOO6qQxsLdspRmrdKajQrahkWGbK2vb6A4ncTCdx75dXAChxA' \
-d '{"resourceTypeId":"07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c","actions":[{"name":"Update Custom","code":"update-custom"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390
[ {
"id" : "31b5e008-c4a7-40ba-bad2-85e0f008438f",
"resourceTypeId" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c",
"name" : "Update Custom",
"code" : "update-custom",
"createdBy" : "90d3080f-113d-4e71-9baa-8aac8f190653",
"createdAt" : "2025-04-30T00:27:44.917440Z",
"updatedAt" : "2025-04-30T00:27:44.917440Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJDNzVtX21oNXozU19Tb3RLTFVrY0ZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE2OTJiNWVjLTYwYWItNGE0YS1iYzJlLTBkYzFkMzc2ZjQzMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MywiZXhwIjoxNzQ1OTc2NDYzLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjhmOTZlNDI0LTZlNTQtNGI0OS1iYmFiLTZmODFjMDI1Y2U5YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2M31dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMWEwYWUxYzUtY2YxMi00NTU1LWE3NzUtYjczNWRmYjhlOGFhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNzc3NDczZjItNWFiNy00NDMyLTg1OTQtZjRlNTE1NWE4MThjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM1fSx7XCJpZFwiOlwiYzQ0ZmVjYmEtYjE5ZC00OWRmLThmNDEtNjJlNDc1M2E1MmMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiMzM5NDZlZmUtZmU0Zi00MDhjLWI2NjAtYmNkYjEzNGNlZjczXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNzY2ZTNmMGEtYTdiMy00M2FiLTk3NzItZTRhNWQ3NTJiYzY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODQ4fSx7XCJpZFwiOlwiZmI4ZmY5NTgtMWNiOS00MDZjLWFkM2UtYTZlZTNiNjNkYmEwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM0fSx7XCJpZFwiOlwiYTEyYzNjMTMtMDgwYS00MjM1LTkxYjYtZTg3ZTZlOWFiODkxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiYTczMTA2NjQtNjVkNS00ZTFhLTkzZWYtNDcyMGNhYzljNzUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMyfSx7XCJpZFwiOlwiNTRjNGUzOTAtNTU0Ny00YTg0LWE0MWYtNTlkY2U4M2RiY2YzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODM0fSx7XCJpZFwiOlwiNzc1MTU3ZjItNWNiNy00YWExLWE1MWItMDA5NTMxN2FiMWQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODMzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fgQRcjBzCHMTqiXjuvizzP9QOIXHkK_PhaGYvMNk7ALvzwIu0H534kPQ4sTk_MB2ZPBpuI62EP7Km19h-svp7RW2Y7fLzyJMmE51QlYrokd2tb8pAbcvAORpDC5-XhIsk5K8cSwCuffjw-rW8T6Rrn-eTeQ3FCVjMUMggiiQsjLdPcROTH14YFdwpC6uHT-GUfDnk8UcYG_N-Ttyqf6m2HtPFlRGv4ZeD4DmkA5M8qqaRlC-f9_SemUhr6v24Ozh309J6rEjuz81VEcQQEJBAdNbTFDNFXXP9s-tzzAhkgPbncC32C3NDg0nILsCNhe89WeEZ98ZlK_toBg2KSzFVA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1755
[ {
"grantType" : "IdentityResourceAction",
"grantId" : "76263aea-9b9b-4d13-9abd-6629fbd019c2",
"privilegeSourceId" : "76263aea-9b9b-4d13-9abd-6629fbd019c2",
"identityId" : "0ed768fa-7214-4404-8335-a715156dff45",
"privileges" : {
"io.netfoundry.auth" : {
"public-grant" : {
"read" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:14.390114Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read Public Grant, All to identity 0ed768fa-7214-4404-8335-a715156dff45"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "903d1241-7aaf-413d-a722-b18143677eed",
"privilegeSourceId" : "903d1241-7aaf-413d-a722-b18143677eed",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"privileges" : {
"io.netfoundry.network" : {
"host" : {
"update-suspend" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.474758Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Update Suspend Host, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "8ece89ec-03d1-4f9b-98b6-2014b79fcd53",
"privilegeSourceId" : "8ece89ec-03d1-4f9b-98b6-2014b79fcd53",
"identityId" : "48ef8928-4f59-4428-b4df-83cd7ec770bf",
"privileges" : {
"io.netfoundry.billing" : {
"payment-profile" : {
"read" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:15.372346Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read Payment Profile, All to identity 48ef8928-4f59-4428-b4df-83cd7ec770bf"
} ]
Super-User Grants
Find Super Users
GET /super-users
Authorization
This endpoint requires read
action on the super-user
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
identityId |
Object |
true |
|
domainId |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].identityId |
String |
true |
Must not be null. |
[].domainId |
String |
true |
|
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].type |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/super-users' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJBUlVpWHBoOVVWcFBPcTZCQXNNRHBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNkOGZmYzMxLTI5N2MtNDU5Yy05MjI5LTNkNzdiZjUyYWI5OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2OCwiZXhwIjoxNzQ1OTc2NDY4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGQ5NjI1NDUtODcwNi00ZjIzLWExMTgtODkzNTJjNTAyNmJiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.MlwCgyY0SDsXYFr1CKRUUJAutoBztxabx6-Aez5QO41vgnbXdZnmAGS2AWwDCBu9BjXbm33qv-HQ_2WJk_gSNAdhiyz1Usdeb7DaJqc0Rz79Z2oV4ChiK_u3ST5ktu68x1WsIIK4GEQ43obeNtYCEwRQXFDAG6NsR_xaiDcmSfoIqil91tMHfP52O2O4E_pu9MvIbB2i29qh-NzI2hbj4ClhYbr2nIpAdqDBdhm4XZ1FmdWWniGpO7EANShLQwox86joDaHBcTIN2OOLIAvn42DT-okIuYefl2aaonhYn-1ynT8fZ-SjHXDft6vQRs33nf1OUOGmk8gJliLpS38g1g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1568
[ {
"id" : "726cb762-26ce-4614-988c-d8adc5a5dafd",
"identityId" : "26e9bb42-2b8c-43cc-b961-bfdf1228538a",
"domainId" : null,
"createdBy" : "ee293e23-94ca-4c47-8f16-43fa12120652",
"createdAt" : "2025-04-30T00:27:48.067787Z",
"updatedAt" : "2025-04-30T00:27:48.067787Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 26e9bb42-2b8c-43cc-b961-bfdf1228538a"
}, {
"id" : "2a0890da-630b-4c6f-ad6e-fe9fc3843813",
"identityId" : "91b55932-b9d8-44c5-b5e1-404232231d71",
"domainId" : null,
"createdBy" : "7b5ccb71-345d-4597-9464-a8754e18efac",
"createdAt" : "2025-04-30T00:27:39.754986Z",
"updatedAt" : "2025-04-30T00:27:39.754986Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 91b55932-b9d8-44c5-b5e1-404232231d71"
}, {
"id" : "fe6f6025-c0f7-48ab-a8a0-d42c2943d746",
"identityId" : "1053840c-b076-4fc0-8800-1b2fce266719",
"domainId" : "b9bc0d0c-ee62-4ff5-9873-dd560d49e4c0",
"createdBy" : "f1e5ca9a-f2bd-4a07-b7ec-a8e77281904f",
"createdAt" : "2025-04-30T00:27:48.210762Z",
"updatedAt" : "2025-04-30T00:27:48.241251Z",
"deletedAt" : "2025-04-30T00:27:48.240576Z",
"deletedBy" : "31946bd3-73fd-42b6-a634-45ba8e6a09b4",
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain 68 to identity 1053840c-b076-4fc0-8800-1b2fce266719"
} ]
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/fa00befd-3d27-45d5-b5d8-71916697472d' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJtS3hNVTVNdnQtazVKYjJiYktxYzRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNiMWE5MmFmLWZhYzYtNGFkMy1iYjU0LWMwMmE0YmI1ZDQ5MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2OCwiZXhwIjoxNzQ1OTc2NDY4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzY5MzEyZjctYjkwYS00MzQ1LTg3MzItZGRmNTRlNDFkYjI1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.FalYMlOSOFZFA4SJ7TcvqsYnGtZkl25ZlA2jkh04EZwZrHMm3P68vI6TJvKKZweT6wLExvrLb2OgAuKcYY8hdsZnrJNnz5xpzwjTiFddmCWG9n4ZIb8KYejVX9qjYH6rL9IO-thvjjqo-w63aYRpxeFYO4thAmhCo8cprGgNmrhbx2Ef0V-PuPNNrOMmfX2uZxAYUXCiEsp_q5-Mmci5EIyp355dgEQK__O8AZ3uw-noe7UaAOt4p_orndwhKIg6g6oYfLhjHR22Ixi3ZDza_exORPRakdaPseBSfzrFk8KxcYshXmK0ZFO8JYKxLzgtzzBR38zEQ8o0Aw6Oit21GQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "fa00befd-3d27-45d5-b5d8-71916697472d",
"identityId" : "26e9bb42-2b8c-43cc-b961-bfdf1228538a",
"domainId" : "285f58d0-f30a-4e24-af22-d328200f039f",
"createdBy" : "2fae8f11-3e97-4cc9-9a55-d57a4001ddc1",
"createdAt" : "2025-04-30T00:27:28.974843Z",
"updatedAt" : "2025-04-30T00:27:28.974843Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity 26e9bb42-2b8c-43cc-b961-bfdf1228538a"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJtdmJveDNYSnE5dmJ5Y0I1XzNkQVZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVlMjkzZTIzLTk0Y2EtNGM0Ny04ZjE2LTQzZmExMjEyMDY1MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2OCwiZXhwIjoxNzQ1OTc2NDY4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTExNjQxODAtYzBjMy00ODFmLTgyZmMtZTllZTUwNGI2YmE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY4fSx7XCJpZFwiOlwiOTNhMzAxNjItNDlkMC00YTNkLWFkY2YtMTI4M2M4N2Y1Y2M4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.hdgLfc0zMQ_iiWsudGTbLbzG0tLpwqsI8JcUleOBb264AhmE2HZnW_72bpJXVdr0YxW1_lAv9AESn5f8ZSSyyQbU5ELQgzuZI6wAvpfZcvc-8RDwBB_zIRWBuVe5k9F-DtZn17a1uxrJsMiPnexydcmgOJfJNuX2f060Ju1rcs5vxsgRQbQyhCZRVkUnYKL2La4cPRrVlm6iv8JvgSzPrUHsgXxDYG_gLoLOovBfoYb26heXWsvlTMiTYWJOA4LaYhxRKwNzk53eAFm1KjuO_M5PZMMUVbt_xkpXol5z990v44E6eI84UP0GhHUeRLgjlrm1rchANCaOPFK5FhPE7g' \
-d '{"identityId":"26e9bb42-2b8c-43cc-b961-bfdf1228538a","domainId":null}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 488
{
"id" : "726cb762-26ce-4614-988c-d8adc5a5dafd",
"identityId" : "26e9bb42-2b8c-43cc-b961-bfdf1228538a",
"domainId" : null,
"createdBy" : "ee293e23-94ca-4c47-8f16-43fa12120652",
"createdAt" : "2025-04-30T00:27:48.067787Z",
"updatedAt" : "2025-04-30T00:27:48.067787Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 26e9bb42-2b8c-43cc-b961-bfdf1228538a"
}
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/fe6f6025-c0f7-48ab-a8a0-d42c2943d746' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJuV0htVlJsdWU3STE2bFBQcGZCdmt3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMxOTQ2YmQzLTczZmQtNDJiNi1hNjM0LTQ1YmE4ZTZhMDliNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2OCwiZXhwIjoxNzQ1OTc2NDY4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjAzZGUwY2ItOGM0Yi00OGIwLTkzM2UtZTZhN2I1ZjhkYmI4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZJ1WnNjCOsbXgUawmvYbNHTgWuXDTb6tkXYGLA_aoUJatoAgnY-HYwKglqf7hRwBApXYYtLTfRhtekThQM78kE6_BCYQYm86YIZMYOnWXCs1Vbl_74HlV701EY93XdIPAM5tpclM7c7gbCFNeOTnRZYfsF4V4suY2faz2pLVGMV-YVWyjmZH9MczPmJI2k3fd8n1RrxLIsgu2t2HOSqMYgzIMS5323lZeUld0N9fU2-MLgp0qPzriWOE7BT3m0M-GXniss-2U1DqYTR1KRsQjY4fzy7mebPRvB61iBp5Dy07mp-B3aViCQfqePWRfK7XuGDgBWKUIYwB2DNCw8msEg'
Example response
HTTP/1.1 200 OK
Public Grants
Find Public Grants
GET /public-grants
Authorization
This endpoint requires read
action on the public-grant
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
resourceActionId |
Object |
true |
|
isAnonymous |
Boolean |
true |
|
path |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].resourceActionId |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].path |
Array[Object] |
true |
Must not be null. |
[].path[].resourceId |
String |
true |
Must not be null. |
[].path[].resourceTypeId |
String |
true |
|
[].type |
String |
true |
|
[].anonymous |
Boolean |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJPMmhBZVhreFdqOGdVTnZKTHdWT0pBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJlNTdhNTNiLWNjMzQtNDFjMy05ZDMwLWYzNzE3Y2JiYjNjZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NCwiZXhwIjoxNzQ1OTc2NDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMmUyMTc2ZTktZTk5NS00NTQzLTljZTItMDgxOGY1NTFmYzQ2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f4u4KjRVSFj6D6zIsFIl0lzmYKWqiu2ymZpm09x2g2oJYYoRYKP90ckMj378r9hwCt7yfOVgGwIAZd5v4C1OzCJqOSTxNHcslmqEZGGxbXiLcPImGIHO1YeYZXIAK_YWr7-ovmnuhernGbHkA1XzHO2mfZbFDrmayuFGrn4VVGNS2RARBxAq1PuHCStSeEMVa-pQElt36v4UGqo1J-0lsqCaM_YaPN1XoJg14L6kdH05U8IPPTKpmB5xG7HkikkfXZGkb0kOH78JlMlF7-swYohJKhGpNVNNa_LVwRYJQYaTihd-WIOmTD1PkktQJ0kOBq7pnP_DzBt7AzX9osJkVw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1655
[ {
"id" : "e8bb6907-970e-41b3-af1d-7b8adae4d00b",
"resourceActionId" : "e995e056-1781-4958-99e0-7e86aef022f0",
"createdBy" : "3d950763-e587-4394-a4a7-751e20c485e7",
"createdAt" : "2025-04-30T00:27:44.669225Z",
"updatedAt" : "2025-04-30T00:27:44.669225Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "e8c9ffca-6cf9-4f5c-bc96-9a2dfd19a086",
"resourceTypeId" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c"
} ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Test Action Test Type on/under Test Type e8c9ffca-6cf9-4f5c-bc96-9a2dfd19a086 to All Authenticated Clients"
}, {
"id" : "c44fecba-b19d-49df-8f41-62e4753a52c1",
"resourceActionId" : "461f5b91-9092-4a1a-847c-f85b6e93ccb2",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:12.942879Z",
"updatedAt" : "2025-04-30T00:27:12.942879Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Read Domain, All to All Authenticated Clients"
}, {
"id" : "777473f2-5ab7-4432-8594-f4e5155a818c",
"resourceActionId" : "838064e0-0727-4849-959c-f9e99ca0e3e5",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:15.421197Z",
"updatedAt" : "2025-04-30T00:27:15.421197Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : true,
"_title" : "Grant Read Network Version, All 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 |
|
type |
String |
true |
|
anonymous |
Boolean |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/821383d5-cc01-470a-a5e2-b1171a64f35e' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJibU5kSFZUb1ltckNDbmF5b19JUWh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ0MDk4NTIxLTcyMjItNDU0Yi05OWJiLWUwMzNiNmVkMzkxMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NCwiZXhwIjoxNzQ1OTc2NDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzE2OGZiNDktNmY0Ny00ZDAzLWI1MDgtYTI0MDBjNDJkNmU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.LY0csQNx2jWSkH2fpsFUqcRm2AHGBkvVTpVARgWmKpIictUDy2yVJL96gpV9SnEdabkC5jjTZXMquLDjJHFfd0FBqiIEFjHEF0imYGxkZco81oqlIP0LgvT7kITamJOCEyBiWUh-0gAVYbKlj-ayEhcdhmki0bk268xI4oNr_om5tV3aJPtbEtJr52KVFcNWZsKE59Owjg_je25s9a2JMqhlsKy2FPHgaaCEl0Fk5vvhGxHEh-32lU2Ho5jNd6ELiQqDSEAZVN8O54FrbkgnhnPv9SZkKosXpP0_7eSTqWwMMGjP_S9_6n4MvMWVyBThsr2ucP42BDUvXPAmm7s35g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 678
{
"id" : "821383d5-cc01-470a-a5e2-b1171a64f35e",
"resourceActionId" : "10fdfc3a-43bc-471d-9ec6-50628ad751b0",
"createdBy" : "1130474f-2816-435a-9036-0b1918579e75",
"createdAt" : "2025-04-30T00:27:44.275817Z",
"updatedAt" : "2025-04-30T00:27:44.275817Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "3c38df32-de1c-4fd7-90a6-1a76b1707516",
"resourceTypeId" : "c44d28f7-e811-4a56-97bc-b6a0f9513756"
} ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Test Action 46 Test Type 45 on/under Test Type 45 3c38df32-de1c-4fd7-90a6-1a76b1707516 to All Authenticated Clients"
}
Create Public Grant
POST /public-grants
Authorization
This endpoint requires the following actions:
-
create
action on thepublic-grant
resource type -
read
action on theresource-action
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
resourceActionId |
String |
true |
Client must have |
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
anonymous |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
anonymous |
Boolean |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJ3bF81b2VsSEN0aWZZaDBYdzN2YzBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNkOTUwNzYzLWU1ODctNDM5NC1hNGE3LTc1MWUyMGM0ODVlNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NCwiZXhwIjoxNzQ1OTc2NDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjI3YjI2ZmEtNDJjNi00YTY4LWEyZGEtNWVhMGRlZmM5NGI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fSx7XCJpZFwiOlwiNjE0ZDQxYTItNzU3ZS00MDhkLTk0ZmQtYjg2NzMxYTQ1NGVhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.MlKN6UbiQofxqQ68oXbovOswD0rj0C7MJY2SVxYCNv6xfHPodAajrD94zr1P2tGH5ovx9L9Qv-r61u8Zgij8rqm4IOk4hz9wsoLcGfjS25XZgDkeL9JEg0IumBrrnxSmHwfl8FpW1bN6AKgUQVYhqJMKIXa7CQFeqgg46sUdhzQBsYzmF0S_9_Lp_vPuytO75nTbadRoaEsDd8afr8tT2Bbpx2NjLHk3jcs-Q3Qtc9PEnSrxcIoSC7ZHQ6JRm86qfBWar28wsdeZ8_Enj1d5QAB5z1DCbHaKBVjT7ICGYLWrh-5wVZ64v_4wcYRGZGa3BRHJZLdWxCg9MDQXjLIXiw' \
-d '{"resourceActionId":"e995e056-1781-4958-99e0-7e86aef022f0","path":[{"resourceId":"e8c9ffca-6cf9-4f5c-bc96-9a2dfd19a086","resourceTypeId":"07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c"}],"anonymous":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669
{
"id" : "e8bb6907-970e-41b3-af1d-7b8adae4d00b",
"resourceActionId" : "e995e056-1781-4958-99e0-7e86aef022f0",
"createdBy" : "3d950763-e587-4394-a4a7-751e20c485e7",
"createdAt" : "2025-04-30T00:27:44.669225Z",
"updatedAt" : "2025-04-30T00:27:44.669225Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "e8c9ffca-6cf9-4f5c-bc96-9a2dfd19a086",
"resourceTypeId" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c"
} ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Test Action Test Type on/under Test Type e8c9ffca-6cf9-4f5c-bc96-9a2dfd19a086 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/5dac08a2-3fc7-4b0e-87dd-c2c8cf0130de' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiI1LVo0NzhwWm0xT1I3S1E3S1pCLWhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhjN2IxNGRmLTljN2QtNGQ4Yy1iZTFjLTlmOWZmYTE3NGJjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NCwiZXhwIjoxNzQ1OTc2NDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjVkYWMwOGEyLTNmYzctNGIwZS04N2RkLWMyYzhjZjAxMzBkZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjcyNWNlOWItMDU4My00N2E3LTgxODUtNTU3NDZhZWFhNzYxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.R8MeATtgOvWcH4VCeipfJaEwtCqlIAQmKCK5QeTwA1mh41I65-v_urYcVx8Zl1QVn4apRcMOurSMkAqRZhtzm9wCPDCTs7lKuQaYs142FlI3QcFrB1LqtIp3hkLj7fKzty0D8Y34V8Jv4-hJtoSBJ9zTw9MgECVYOM2J0rhAsLwkJLHrcBNJjpjMaQNOzzvYS8dJni3lFmc0UNK2OviMoMglLONQVbdGtvuLQB98ZuBQhuPePrEeGTuqqypLlVqxGSjrL3XsMuJ0k3Dq1Ow0sbnnvGAYqQGIfA28lsgM0uUE39wQX9fphToO1mpy1oeN6Iu_vEeNQxDFB-gkcbac4w'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJZZkgwdnJQa2NEV0JQQ3ZNYXgteC13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQwY2E4NzA0LTk4ZDctNDgzYS1hNDZhLTA0ZWRlYmYxYzEyMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MywiZXhwIjoxNzQ1OTc2NDYzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZmNhOGQzMDYtNmM1OC00ZTk5LWI0MTgtNDdiNWE2YmMzNDllXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.TNw5YGcWwu9QHT3BgM69kgdYD91NRrru_mhe2gLCxWoT3A5JY-bzCnLjZy_8uR82lkqk_k-oa-PAzBlGo70LOl9SeiYJFyuWenUbEKFqiZitOdzA_Ww3ssKXFDJns8ab-1i5DYJ3a5D6x694IX6RLmuQ__Y6C5SmUhvL5nQ3IwlGIJRAS2BDSJcZ3WvaN0r_fFaKV94IapASjkIv7YbPx9yktCTfp27HbzgcNAlpDVdpNiBYDfhGjXzJkbN9-hGdbCRhsGJf2pke4lxxIpdlvynFs8PrczuObVOgTLd1c79YUoGhFkads_DH8I2tGa4sBSteVXwMcadSAMkihU35gA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1728
[ {
"id" : "662f92a1-a0ea-480d-bb53-1377d586cef8",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"resourceActionId" : "2d172eff-a92f-47f6-b966-d69bce946068",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.139832Z",
"updatedAt" : "2025-04-30T00:27:16.139832Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Delete Service Identity, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
}, {
"id" : "a7865065-9522-475c-a3d5-f63188769131",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"resourceActionId" : "2b21583e-316e-40d8-a8b7-136832fd903f",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:15.991782Z",
"updatedAt" : "2025-04-30T00:27:15.991782Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read Network Host Network Host, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
}, {
"id" : "6058d1d1-d824-4fd6-862b-c5f890fcd681",
"identityId" : "16f645d6-e5ec-4d27-a542-64891f58b3a8",
"resourceActionId" : "730ead0e-b676-49d7-9fc8-dbe4e40d79f4",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.108426Z",
"updatedAt" : "2025-04-30T00:27:16.108426Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read Intermediate Certificate, All to identity 16f645d6-e5ec-4d27-a542-64891f58b3a8"
} ]
Get Identity Resource Action
GET /identity-resource-actions/{id}
Authorization
This endpoint requires read
action on the identity-resource-action
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/identity-resource-actions/4cfc290e-37a9-4952-909b-1c6bc829a881' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiI0N0hMdmRwY1ZoRkdEN0JmRjQwRFp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBkNGU3ZjZkLTMzYTEtNDU0OC1iOTYyLTY2MDEwNzE5NGUyMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MywiZXhwIjoxNzQ1OTc2NDYzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTQwZDI0YjktNTUyYy00YWUxLWJiZjgtZGVkNzlmMDg5ZDE1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZywAy7PRaJxVxTi78B0DGZjKz9aiXTT5H0NYAxEyAvJfRkVWEOk_L1I8aUFeJme8luJnMtynesPzIEox_p3bG4sLZd_67rSvOrvpNGSVeb8FHq1Ua-ED7Q66vaA-m-shUx6FhMkoobqUSufcoZP870iba5XlP79dmHeqpk7hVdMr2vIzpROHkw6zK1OxytTi35nOXBUgRVH7MWu1y1ndJvXFFx5ZQFnpJcdTsvsRS-3ejLo98bfs98V35aTWl9sTqAjCwU2fwDLjw1d5L0kvnbd2TiJuSBHPQo3qDtxAhSQwk4H_1TiI8mVKjr-BkyIZyaWsBtk2SUYdPjLsZoFZLw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 754
{
"id" : "4cfc290e-37a9-4952-909b-1c6bc829a881",
"identityId" : "55ff1789-f681-479a-a85c-c595166baa18",
"resourceActionId" : "5cd90b5b-7534-4d81-ad2b-ab16ff1803b5",
"createdBy" : "c0ec1be0-ebe5-48ef-a8e2-73c8d94d960f",
"createdAt" : "2025-04-30T00:27:43.847242Z",
"updatedAt" : "2025-04-30T00:27:43.847242Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "966ddffc-b141-4f76-b864-ec466858b59b",
"resourceTypeId" : "818edb3c-1860-4dfd-8f4b-fbe120335db2"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action 43 Test Type 42 on/under Test Type 42 966ddffc-b141-4f76-b864-ec466858b59b to identity 55ff1789-f681-479a-a85c-c595166baa18"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJ4WXJUWHJlMUZzVG1HcHUtVzhxOFRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM5MTIwZDljLTYyMzctNDNlYy04OTUwLWQ2ZmU0M2JhMjZmZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NCwiZXhwIjoxNzQ1OTc2NDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTAxOGIyZWQtZTNlMy00YTUyLWEwZjQtMWI5NmY0OGEyNDhlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fSx7XCJpZFwiOlwiNmI5M2M3YTAtMDBlMC00MTU3LTk3NWQtZjNkMzk3NmMwMjgwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EQt5S8Wg-mThKCDwyWUdxBWil6Vk9U4csSYD425OX6CKHwcl27sht-AYx6R6fp3imBB1Aio0aRXVDyctLKZpyF-RGP5iUGAeD1G6X1lU48WHbpVNbGXCFeyIdXv7phHxTxTdnuX4zYfIeDSnVsB-uIDyQeC6eyUpH2xq2RpoMQGEFtzkE-XvveYTQOO58VzzpxfUwHHR8NH0-i3KF6qSKrZllpmFV_Zff_-argLxjy5cLzsqHZTH6j3tJuUKkremlIS1PdxlfxuzWkN3kThW1g7V5tTok2ksxgvUBw5vKKb7NSfJpXps-ODjGUEkIfyaqMzWVOSTwwCn7ZvsRLXrlw' \
-d '{"identityId":"7922a689-5742-4b80-a3ae-141f546e2abf","resourceActionId":"e995e056-1781-4958-99e0-7e86aef022f0","path":[{"resourceId":"ff24ac8a-7fc0-43c0-b95d-3aa4299f1955","resourceTypeId":"07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 745
{
"id" : "aab16316-2133-4b4c-95d4-9ef7ea977f1f",
"identityId" : "7922a689-5742-4b80-a3ae-141f546e2abf",
"resourceActionId" : "e995e056-1781-4958-99e0-7e86aef022f0",
"createdBy" : "c9120d9c-6237-43ec-8950-d6fe43ba26ff",
"createdAt" : "2025-04-30T00:27:44.071365Z",
"updatedAt" : "2025-04-30T00:27:44.071365Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "ff24ac8a-7fc0-43c0-b95d-3aa4299f1955",
"resourceTypeId" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action Test Type on/under Test Type ff24ac8a-7fc0-43c0-b95d-3aa4299f1955 to identity 7922a689-5742-4b80-a3ae-141f546e2abf"
}
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/e8c5eaee-647f-43e0-bd61-63f21d5cd89f' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJqNWVqRUpJdll5YXZvYjdCNkhsZm5RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJhZDc1YmViLTI2MDktNDQwNS1iODIyLTMwMTNlNDFhOTZiMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MywiZXhwIjoxNzQ1OTc2NDYzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzc1M2U2YjMtMmIxMC00ZWY1LWI4ODItNzRlMTNhZjBlNDg3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.BApihaGcIzAkF6NC06nBQ2OL9dm4VJtgsYGyjGxYURY6E6FrhPbj45yVHQSLMoHuTdmrd8r74ZIL3Samn9rAXahFSPAuO3zs7btvh7VMJCDyT9vfh19J7ydKFW4s7pKlAfGgTy8sddP-utDLxgXzqH8IQAA6bPihvh8fsgUvfgVeZmihb_2SSKbl67OW3Pq5o-O7-I8Hu6qDtfehJWicV5gctt6kJKhdCyka3thBhZgqtgmoUsZm2pw0phvuemHcJckFt72oLOwwo5F6fmY1rqSJTY6uYKW3wrByxoY7BEqPtYpSiT6YZtGPRhFTd0MG77Rs482qjyD7PIEhVA9OGA'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJLTlVzVEUyaDJoS2ctcEZHYjZrOXdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU3NzY3NTc4LTE1YmUtNDU1Yy05N2Y5LTg0YWQ0ODZkMzJjYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MSwiZXhwIjoxNzQ1OTc2NDYxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDYzZTg5OTUtYmQ3Zi00YTZlLWFkMTEtZGNmMDI5Yzc4MjMzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.OepWxBjNXf7KUyAn1HKOZ75rXxObwtxVmee5bhzOBk0pFmSaZ55awtrl0KHMXPHXjT25M41TOZLC8loLJtGlvL0Gxv1BD3q6mNQexFvSTDNQn9BNoVPuUOQhIpsvqvFKlge4dDCVyOn7wY-I2gwV--sNYeyjE2pSkB2Yh8Gz-mmNRJTJr0jj29spJDX3vAOghTdNE9MxxoUEXhTMKUH4YONw1sc__Xvy8XXezHbpv8JR_PTDncyxUhm3N_6y1pSkneMdBMp4zWpdmBrrKjcEDqfzHIBHoiygZhDIj862kN35YXzqA7YCJKdhmFDNl5HZbxvLYlZJ_oCvDyny_1umfw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1157
[ {
"id" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"name" : "NF Support - Intervention",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.279101Z",
"updatedAt" : "2025-04-30T00:27:16.279101Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "NF Support - Intervention"
}, {
"id" : "32e834fa-e1f3-4bf2-8efb-30059c887c3c",
"name" : "Test Custom Role 23",
"createdBy" : "a7c254fd-8729-4be9-ac46-882141f0c4be",
"createdAt" : "2025-04-30T00:27:40.315535Z",
"updatedAt" : "2025-04-30T00:27:40.315535Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Test Custom Role 23"
}, {
"id" : "e81ae0ad-f566-4563-99a7-ef394e4145f7",
"name" : "Test Custom Role 22",
"createdBy" : "b9417a91-b111-4e4b-a713-b563ac6d0393",
"createdAt" : "2025-04-30T00:27:40.042352Z",
"updatedAt" : "2025-04-30T00:27:40.042352Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Test Custom Role 22"
} ]
Get Custom Role
GET /custom-roles/{id}
Authorization
This endpoint requires read
action on the custom-role
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles/ca52e3b3-4057-456d-a7ea-ac96ce5bccd1' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJzb2xBRjd6elpxZmNMUjlYT0IzWWZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE4MTQxMzI1LTQzNTAtNGY0OC05YjhmLTk1NjdjOGMzMGFkNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MCwiZXhwIjoxNzQ1OTc2NDYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzgzNjE3ZTItODlhMi00MmE4LTk5YjYtMTRjNmVjMTM3MGQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jUUpW7vqD8kM9L-7i0uljQWj70thBYmcuCEgIdgRiohurvkdJYf8-bIt_9smDoBuooVp703GwW0Uk45PnKGnIbhpFZPvEk05DiWogLHTTAfS7sZvnCDcFza-36_o7tYK60O3rVBNf9v-O4rMDEFS2oU-ZsQzfOR67vvYPBYaTwVaYHyb1YNSLMth3NOgZYLOtR7l6fsYPruUdYD7ctMi3OhrlrOmS8WDEH1JpWR3gEL4pstAuHoZx_v85J1Fo-F1Al2KrNQQB4ZAMbGdKuVf7p9X52t-2LuCuZYnCt0V7ixcWglZx6GwLqLAGbG0sDTGbNu7xk68k1-Qg-KrFRFtIQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 379
{
"id" : "ca52e3b3-4057-456d-a7ea-ac96ce5bccd1",
"name" : "Test Custom Role 31",
"createdBy" : "b1a80f4f-8eb7-4c09-89cb-988954a1e761",
"createdAt" : "2025-04-30T00:27:40.933176Z",
"updatedAt" : "2025-04-30T00:27:40.933176Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJXMmdvRXczTnZpMFVwdlV0V2FFak9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU0NGE3YmFmLWYwMDAtNDgwMS1iM2NjLTAxZmFhMWI2MTllOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MSwiZXhwIjoxNzQ1OTc2NDYxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMmQ1ZmIwOTQtYTMyYS00MzYxLWIwMGQtNWY1NjQ1YWU3OGU0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.BPWRzPdMWhxz70C6fR5qkIeowRYmrmBIhrSiz0WMJ8l-KPgwfRyqkDnPFvY2PBiQ33zZ8rzQ2HwTTuNIvUxS8FMJc9yJUw414dFkFkDAoiZ7cJmmERK3q4vXK-JBs7L8dATtjFWOalh03kYjObQFiZuQFQM2FbpMU-YYBJ9rbnXZgMmF2xeSSPqfIhb7BfpvMURlQgTpwL2OGDbQC6nRijy0NJf5YJ5PAYTk71t5_QKRVj1bmmEUuNd44lz-sXAHQhD_RQNeds1iyeSNEs5NGOcbcieNvkYcJF7Suxu5sJORgMkVfu6FNXN8bk5g0-Ogvo25U0m7kRMrKkKyaFwB6Q' \
-d '{"name":"Test Custom Role Create"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 387
{
"id" : "f87430d7-0351-46ea-8110-24c8bbc25857",
"name" : "Test Custom Role Create",
"createdBy" : "e44a7baf-f000-4801-b3cc-01faa1b619e9",
"createdAt" : "2025-04-30T00:27:41.496386Z",
"updatedAt" : "2025-04-30T00:27:41.496386Z",
"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/c532cec3-c4df-491c-8236-969cb38df9c7' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJ5NjFyaThMU1hwOGRPYzhJcVZJaXl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVkYzJjYjYwLTk0NWItNDA3Mi1iM2RiLThmZjIyM2RiMDY1NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MSwiZXhwIjoxNzQ1OTc2NDYxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODVlOGUzODctY2RhMi00NjE1LWI5YjQtMDI0MjM5MmRlNTgzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Lc5h0umwMYu2-JQNLbdrCuvts4KYsQKUZOEmgvWVjRWcB3dD0OHvmDDFxnXhBCpRLAR7Ri3AxM13Vns8S1EbB9j2QLAmQw-C_KAtjueVagCWWheUeFtH8073EoFCGLCJ0JgRKEut3AD-5vhlvnVlkghO3jP8zBcQNwPDj-VgytatIi-2Vd1tuMOsgRrZdGQN_Jq01xJ7ubYWAhON0CzS5pgB3nJkScB8sqZ3r9rJoIlBA_hyOAYQtMadWHnm5hgCoEtAlWrItWtXsaxNZLxG8uFul2tNPXxcic3s65Mnjv-wB4aNr_QCqkgXbjTE7UcLWMkIc9xNOhyI53gyNA3iuw'
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/08f760f0-752f-4549-9e2c-dbcaf641a545/identity-grants/0eea69f8-c21c-4755-8d44-5782ba41fe11' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJmNDNwc1VSOTBNM3h3S0s5WXI5RXh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBiZTNmOTMzLWFhNWMtNDQ4Ni05OWMwLWY2ODg2MmY5YTdkZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MSwiZXhwIjoxNzQ1OTc2NDYxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDRlZmM5YmYtZTdlNi00OGVhLWFjYjUtZmFhYzhiMzYwOWM3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYxfSx7XCJpZFwiOlwiMDY2ODcxZjctZDJjZS00MjFlLWEyZDYtNWVhM2JjOWVkYjJjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.LgGjKIFheSpDYbmcv-8NDYM1sGHjNzGgt8dJmk2rWgXPf0IzJ9Yk4ovVXhMwbpESCo7Fpq-pguABix3lt4mWpIFn9G53dCxhu9zXwTo8-DrIrhQ5TUezVn2wXYkgTBnUe-sM9csSbF7D_b1gKWq9iFKEyiKDlreJbWIETjhSrfW-EZDyKMHRnjeH6hnttiqNNsvblXY0OpbrLH3DJ_B6IAq7LcjwFRj7XDWXeNBNFAKC-jXXUxWsyFqug5md1qM_YvFDNzowQnhs7hMV4lWckRTIh3lgG09paxcKOd3TEOqkmOpsAYAf0343NTT63NoYUg_Fk9LN2XNJd6iezkAEBQ'
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/8624969a-5015-4341-bd53-1e3d4c4815a9/identity-grants/a7d51b37-3088-4fd8-90ad-c5d0917ff215' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJ5X0FrUkF4ZEZLaFBFeHFDdkJoSFl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc5YTY4ODAyLTRiNmQtNGQxYS04OTQ0LWQ1NThkZDgyYTIxMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MSwiZXhwIjoxNzQ1OTc2NDYxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjU2MTQ3ZjQtMjk3NC00NWY5LThlMzktMWQ3MTE2ZjFjNGMyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYxfSx7XCJpZFwiOlwiYzJiNjc0Y2EtMDVmOC00ZWU5LTk4YmQtZDQyNTY0ODhlZDQ0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.CrJSosSS6hASbNLohShU1hTsFdWfRCTimz6Y_nTYlDBdAJIXVMeL57X_Fntj58gr9CQoO4x8BqqpLGQrt4f2pcaFvrz9WZMekLUzsm2hi3x4ZEgYRtjKPKspX-2Nmc6WqnNzKCs6axQM3VAd3PUt7e2FvBuuhRyVzMycZqY2pfVSqrB08JrSRzJvi5gQtNl9mbQI3qt9sTb4J5kLhfLtb3Z2FXL_QbMNpn5HiBDiqbdhMZTyxwbFcYYZoMizYmoKCc77-vfJNsHTFU9Z96OP-E4xrTio3CZBGVS_9YtYyakUysgguhfeRXjvUhLOh2Ywiz2Frt9Mi1AMkOHk345aWQ'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJJcUY2M2ZqWG5MYUVLUTFScTk5bXlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRlZmRmODhlLWM0ZmQtNDc3MS04MGNhLTBlYzQ5MzRjMzQzNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MCwiZXhwIjoxNzQ1OTc2NDYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzcwNGNiN2QtOWMwNC00MmM5LTgzNDgtMjdmNzE2NmJmYzgwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.c-2YdEmbXM83OSNWeeJ9Gx7azhH_yFBYk0QM3ZvJM_NsHUGSCCj7kLRDW1cXSbyEUopDwGZBM23Y7-pbX0zmjaLI1sYMnQZ7e3zKSz1VrH0zA9RTt-f6m1PZ75N_FQsj3NDKANC9jtHyeZyCxCvhvuUeUCOGfodfI4XZS8Im1KoCuF-DEi-ultsy2saz1FX04Uo-nG27IkWTMfGnKvMlV--r6UE5jgMbMsgpyBm98AUWyZIY4yM9ZibtrmIyrWo3qrN2N7amhXE3WQSGsvsOI5RuF2lmNPGQMjTpv0fV-cFLLMG6rwORj31oRH0cY6EVT4mm1yX_hMJLNiAAXUWjYA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1282
[ {
"id" : "9e89a9cf-4299-499d-9d43-00387ff61305",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "70e75523-73ac-4d68-80d5-39894c780f8e",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.283691Z",
"updatedAt" : "2025-04-30T00:27:16.283691Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Certificate Authority, All"
}, {
"id" : "2eaebfff-2c91-435e-934f-db22b78e190f",
"customRoleId" : "74a9a6c3-106c-40bc-acab-780c837ad8d0",
"resourceActionId" : "545a1cae-80c8-46ea-83c4-05cc4e711fae",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:13.407642Z",
"updatedAt" : "2025-04-30T00:27:13.407642Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Standard Role, All"
}, {
"id" : "252312cf-ef55-40fd-85ef-b6f48a93cb93",
"customRoleId" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
"resourceActionId" : "b55538d5-326e-4c9e-a548-4fce6d9ae468",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:13.239214Z",
"updatedAt" : "2025-04-30T00:27:13.239214Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Geo Region, 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/b90c3210-be8a-4060-a6dc-2fc3ba0661f9' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJrRm0xMHlTdi1Sb2x4Ty1SY1dHbkF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUzOTJmMDVlLTgzNTEtNDIyNi1iZTAxLThjZDAxZTM1OWYwMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MCwiZXhwIjoxNzQ1OTc2NDYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGNlMTk0OGMtMTVkMi00YjZhLWI5OWUtOGMyZTQ2MjQ5MDkxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.CrYcRViGA1PxUB5CLX9P69WZ3P0UVBhFHHAp3LljONjw4vpmAcbLcpd1qG8kX1z6i_QBqKgOyzuRdm4ztyDF7anESShioW4yqb-871S4t3H9PkIOrjWDcwYg8nS1Op6-wWBTito0zIKZNfiyK9HWYNmxtt3zXwd470T2ObmeIs5agZs6GfuydmeV6zmXIy_wzy1WuN1NqJlvDkBtjAh1nCq8mS7AnoicPFcDIjRyDP0rRpCx2Y-eSc_HnKluXzKLapTHXKzbtms3GbI7ylbj4apfZ4zMlA1mn9q2opu6k0fvuLXoY0fxhcSy-QcyO6jGxbP5Zn3SbKYz4F7QQDmq6A'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 613
{
"id" : "b90c3210-be8a-4060-a6dc-2fc3ba0661f9",
"customRoleId" : "32e834fa-e1f3-4bf2-8efb-30059c887c3c",
"resourceActionId" : "b57181b6-d864-4473-b3c7-31c678e8cc74",
"createdBy" : "444eeca5-75ac-4ffb-ba4d-642f736cb8cf",
"createdAt" : "2025-04-30T00:27:40.377634Z",
"updatedAt" : "2025-04-30T00:27:40.377634Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "d2c44311-bec7-4834-b191-20ea5158b1db",
"resourceTypeId" : "1f669a18-c0eb-4cfc-9381-4cda4f0815be"
} ],
"_title" : "Test Action 26 Test Type 25 on/under Test Type 25 d2c44311-bec7-4834-b191-20ea5158b1db"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJXeGhGZGd2aEw1anNUZTJ3WGtUNEl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE4NjNiNWU0LTFlZDEtNDVkYi05OWI0LWIxZmZmMjZiNjQ1OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MCwiZXhwIjoxNzQ1OTc2NDYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjFhZDljYjYtNTg2Zi00YjViLThkYzItYjA0MjE4M2U1ZjE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYwfSx7XCJpZFwiOlwiMjU4ODFlYzQtNDZkMS00MWYzLWI3MzItOThjZjE5ZTk1NGM4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYwfSx7XCJpZFwiOlwiOWMzOTMxZDEtNjA0ZC00YmE2LThlMDQtYmIzYzUyMTAwMGY1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.YIK88Dig7R3ZMXsqBUFaboGp2f3Kfe5NrRYc5bNW6Qze1a64LELtYMnDihy5MJ5UIl62uKVc2aNHsIW3Wcz89IeTq0iLo9BRzi2I6iLyAtiSkCPEVM5Xh5zCSc4E2pWeyKTDlfbc2g9OI9RZTSNeuqY65kWixXFVaVVQf8QTKbiNRr0uFtEwlO-jkP7-YOAiDveMkwnbIV1RbuQv0lJTCIlkJlfxt-3mYdygPyVCRkJXvba0sa1f8V2gqxyLFWDREOlji6R3z11z0CH_u1gc-Uyv8IKkE7iiyJYTYBkdy-RucT8WlQOvSLfLnu40b4yDZLyQTzEoaklPNEufUpWF9Q' \
-d '{"customRoleId":"e81ae0ad-f566-4563-99a7-ef394e4145f7","resourceActionId":"e995e056-1781-4958-99e0-7e86aef022f0","path":[{"resourceId":"c1be03f8-e4aa-410f-b1f1-622210111963","resourceTypeId":"07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 604
{
"id" : "3bc59a03-0981-4295-9d93-ce520d25f0e3",
"customRoleId" : "e81ae0ad-f566-4563-99a7-ef394e4145f7",
"resourceActionId" : "e995e056-1781-4958-99e0-7e86aef022f0",
"createdBy" : "1863b5e4-1ed1-45db-99b4-b1fff26b6459",
"createdAt" : "2025-04-30T00:27:40.197553Z",
"updatedAt" : "2025-04-30T00:27:40.197553Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "c1be03f8-e4aa-410f-b1f1-622210111963",
"resourceTypeId" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c"
} ],
"_title" : "Test Action Test Type on/under Test Type c1be03f8-e4aa-410f-b1f1-622210111963"
}
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/1566a3d1-a474-489e-9284-0237b17a7b03' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJUM1R5NjNBM180MmZCS1V3el9ocUx3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJlMTA2MDZmLWJmNDEtNDI3ZS1hN2UxLTNiMWE4ZWY0NjMxYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MCwiZXhwIjoxNzQ1OTc2NDYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmNhNzAwY2ItMWY1MS00MzhiLWFhZjQtMTNhMGM1YjliYzg4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.bHEQWS6axLn51yLsYCnNl4m1FbxlyF8vjzuJUBiQbze5aXQ7qHWZ_FCvU8OzG_1pr__l_y1aPsH4ghazvK1oixCMx_siyVj0qhiIKRD00QgA6a9-MzeW3htneTxFXHMlBmfCoiBbJtRtlthQYv6rmHvKpG2OJ0sh2ipGy-FslegZA8HD3uNYwsGRhc3wrh1xgxUFfh5Dl52n25M5gZR1vVqjaF2SD01rBrqu8xrRP5zO6xjflHkfSzj68gu4qs0R6rO7mHI7wXu7CowIHOGX3UTohwXTbHQD0BnMZCP9XUku5k48VJa6CO9oE86XYb9bJdbfBFJUztwt0dxkA1pB5w'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiI0dDhaUldHZkM2UDEwX3BDaUZGNk5RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMzMTZmNDBjLTRkMTAtNDk3NC1iMzRjLTdhYmRmZmE0OWQyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MiwiZXhwIjoxNzQ1OTc2NDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzU2YjkzMGUtNTFiNS00YjNhLTkwNjYtYjJiNjAyYzM1ODM1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.dtK3YjSlmQFmoQIhdRJ0pdze9AGqflRsrHZlY8_iEYOGm8s3BRTR72g8cjIm7xLnLPpe1tsYg1DbdjJucWv7HUrjCBsalc3jwBYPY_onaudcfmEGV4-r-c-1sCenUxHy0TUOA-8twDCXQr9MAguv5AhVC7XS0LvaujlBUuh7NWnKco_OqOgXxpL77fk-8zuKokpWxxzqquiHUPmmahRcFwvGN_AskmLA6UNvVEoOsbdAuEG6sQHlb6UBIFj7IwZKkdyVa53-ho1RFRnI6Lh_2MqDAbeqohrZ6HQj3rMuF1KBKAIHu_p32nk7UIaWIrNTpQGxc5ydbh5guZLg3jHpJA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1415
[ {
"id" : "ed33d4ca-2184-4b89-b5f2-3d7c31558ccd",
"identityId" : "83d8cce9-1ad2-4ec1-ae23-9d1f3d28f2ba",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:13.172129Z",
"updatedAt" : "2025-04-30T00:27:13.172129Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 83d8cce9-1ad2-4ec1-ae23-9d1f3d28f2ba"
}, {
"id" : "8389fb0d-a9fe-4268-a919-f6ccdf3c6851",
"identityId" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:12.780480Z",
"updatedAt" : "2025-04-30T00:27:12.780480Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 2b6f496d-36f1-4e66-a205-8abcf1d41d74"
}, {
"id" : "b77e03c0-a05f-4535-b30c-fdf17fe54476",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:12.778954Z",
"updatedAt" : "2025-04-30T00:27:12.778954Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
} ]
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/7386e882-18fa-4f7d-94fc-6b7b20ec93c2' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJYN2RKYk5YeXNCX0xjS3haS3ZOS1V3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE4NTYyYzMxLTk4ZDQtNDM3Ny05OTc4LWU4ZGFkYTEwYTNiMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MSwiZXhwIjoxNzQ1OTc2NDYxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGE4MjRkMzItZGE5My00MGM2LWFmY2EtY2IyMDdiZjMwMWVmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.VcPP8vB1pspMyAutFrY7si0D4Yh1KLogCCmD2FSfoqN7eUTIPFSVZf-A__R5dkVbgNm6ne_yBTkYWAbs3AoHuqp--hn4cHmllgVlS1ZsVYqHcEh_fnbKGjH93oGJrfSAPwoNzN_EbPN3zJAa27ZArPj-THloKguVopYK939MXFa6c-09m_8T3ABTD3jo5S1Hs2KS306gX1yd3CTJyi9IHnY2L4np9RvaCR5y5OKL6OHuBAqGwYEOkOViMbORCWsIkWxKIwqDz7KdZXaCxSRljIBvnvsHf5s5CHCmiOJpo9LMP_3TeRdZlSPRPL6oEai4Kt7O7lynpepiSzUlYzMG8w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "7386e882-18fa-4f7d-94fc-6b7b20ec93c2",
"identityId" : "5344f884-5646-4a3f-8922-b4e7bc5c21fa",
"customRoleId" : "dce30957-9ccf-44c7-8e7e-0a572b5ddfa4",
"createdBy" : "473e696c-12a3-4da8-93c1-c84fc9a1604a",
"createdAt" : "2025-04-30T00:27:41.810839Z",
"updatedAt" : "2025-04-30T00:27:41.810839Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 35 to identity 5344f884-5646-4a3f-8922-b4e7bc5c21fa"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJjOVRJQklnQ0FlSnc1dHNaMGQ0MFJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUzYzdkNjYzLTc5M2MtNDBlMi05NTIyLTNkZjBjYjliYTkxOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MiwiZXhwIjoxNzQ1OTc2NDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTI3ZDRiZmEtMmEzNi00Y2I3LWFiNmMtZWQyMjFmZWZmZGEzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYyfSx7XCJpZFwiOlwiNjdjMzUyNGUtYjcxOS00MjEyLWE2NzgtOGIwOGMwNjk5ZDMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.XIWcRkyXbccGSKe7O4-jc0rbFufBnVs7fmeEMuTx90dKt6xvT5PeKrvkGnDriMwJ5E50FpD9azAc2g6lGttB2i8PEK4wFSoMGJ_W2LRuapj7zavi8vUv-uYEvCKQwCV_SIZ6w-nXUi7f11aypfrrDwOgTdzkjzc1jcS4WRO5hWsPaRtmqTaraUV_xQreWOBChE0RVIi59k9xSihCsK3nBNm5X-VuS8VLQuct9dnIiqfF-6uLH37HyEVFGJBtbDr93Mm6G1GQCwq4m7s6jui2nDRfJwBgpcXF5mYBCWlkISie05bmL0molHRy07FcUY045mud4Q-LiSxq4rG_VGyY1Q' \
-d '{"customRoleId":"cfd8db82-5d55-4ba8-a7b0-c3bd4f913f0c","identityId":"c18f1256-e217-4d63-813a-4cebb35544fd"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "bab5d8a2-5fc5-4184-89f3-823d62e1988d",
"identityId" : "c18f1256-e217-4d63-813a-4cebb35544fd",
"customRoleId" : "cfd8db82-5d55-4ba8-a7b0-c3bd4f913f0c",
"createdBy" : "e3c7d663-793c-40e2-9522-3df0cb9ba918",
"createdAt" : "2025-04-30T00:27:42.187355Z",
"updatedAt" : "2025-04-30T00:27:42.187355Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 37 to identity c18f1256-e217-4d63-813a-4cebb35544fd"
}
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/0b67c1ac-b2b8-4103-8e1e-35796931f8fe' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJwOFRWT0hVVjh3OVRBc0tDZU1YTU13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI5NGNlOWNmLTRhZDMtNDJhZi1hMzM3LTZkZWMyNGYyYTg2NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2MiwiZXhwIjoxNzQ1OTc2NDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2YwNTZiMTYtNTJjZS00ZWIzLWE2OWQtZDI4YzBkMmU1Mzc5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODYyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.TMwQ93KYn4Mzk81qfx_rDOVxE9kyjBXo69qJr2AmNDGTzFU8w5hBlQFR6JFFBmpa0tb6hz6VNUQsJPyhwOPo7Re3brBTasKC73BHvSUlr-3n1AUA7PTRfzy74oD-ZllBEq6tVQjr0-D5RUkEnWePiycfIj3nqdpTp1ubHLfR7d2iH39WPaOEveiAJBzBGt6qWo_Q6-2NIobd_IP3F5u_8Jw4QfooBg0v_rVNFYnVMF2q2iOC4HP8QpkBJcZBB3Mcm_nUjvmVE-nHCfntHr-ctIQXVo-0Jk0jr9dUIMMCzj2uY82glK0tRM2I0TPcraXZcVVUDqSSnvp1cnbXkoQK1w'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiIwdkc5STczQzBFa3U3VURBMmNnRmxRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg4NjNhYzBmLWYwYTYtNGY2Yy1iN2E3LTZmNWI2NGZmMTFmMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NiwiZXhwIjoxNzQ1OTc2NDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGJhZGI2ZmUtYTAxYy00ZTJhLWFlNzMtZjc2NGUwNzI4NDQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.H427LIe1PvGb9VDIxGCu2uGKlZg8p366snSkr06srxqXLf4Hb1oSd59zVHqgeUpnOe4pM96gnU9BR2uKYZfbU6O7SGDNyyL87e4riATuXLdMegAbCEFc61jko3hRBpK3jaTSVEwf1OuBPIjKcj7WfY7Hl9ps5qDKj6z0c3xf2jxw1fdUvpHnoegt9WUBiAKgILY-lkwFxRsvlTAS_BIV8u-yE8V91SRh5GhgiG-TmQMlDGdMZxj2LiTGtn0PhdHHWqyR8_1DENE_9ygDiLqfWD1ehyM8P95JpCVaAscM4I6bFhH6S3b2hZpgzZR49tIAu3LgNRoVlHVBk_lQPQrJwg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1799
[ {
"id" : "c50f45f7-da34-47b1-b94e-b2b30cb68499",
"standardRoleTypeId" : "aad08651-3482-4049-bdcd-b344d3c26e77",
"createdBy" : "315c7a0f-25ca-4fac-8c31-6e6ad6e1c691",
"createdAt" : "2025-04-30T00:27:45.982263Z",
"updatedAt" : "2025-04-30T00:27:45.982263Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "6535ad69-013a-4704-aeda-dc9a6ef586f7",
"resourceTypeId" : "e1d33165-a874-477d-9e13-45a4e9df9962"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 51 Admin - 6535ad69-013a-4704-aeda-dc9a6ef586f7"
}, {
"id" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
"standardRoleTypeId" : "e1522122-cda1-4f70-bfc7-65591d743121",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.322769Z",
"updatedAt" : "2025-04-30T00:27:16.322769Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "f0428619-11bd-403d-8b00-a463ff8aad84",
"resourceTypeId" : "e14c9d80-17cb-4229-9536-723ce9322dab"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Network Group Admin - f0428619-11bd-403d-8b00-a463ff8aad84"
}, {
"id" : "19a208da-672c-4a3b-8cb4-848a9b0d612e",
"standardRoleTypeId" : "80d27d79-3eb0-4f70-81a5-206d18ed8d45",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.323278Z",
"updatedAt" : "2025-04-30T00:27:16.323278Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "f0428619-11bd-403d-8b00-a463ff8aad84",
"resourceTypeId" : "e14c9d80-17cb-4229-9536-723ce9322dab"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Network Group Read-Only - f0428619-11bd-403d-8b00-a463ff8aad84"
} ]
Get Standard Role
GET /standard-roles/{id}
Authorization
This endpoint requires read
action on the standard-role
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
standardRoleTypeId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-roles/5fa9209e-0ed7-40f1-b9c7-910b1bfcdb03' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJhOGkyY3VjME1maGpLZmxvTTBhb2Z3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRjYWY0NjEwLTQxMjYtNGYwZi05YWNlLTNmZTcxOGZmZjJhOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NiwiZXhwIjoxNzQ1OTc2NDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjUyMDk4ODYtZWRiMi00MzI1LWFiMWItYTYyNTliNGQ2ZDMzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ArSbZulhhSayvAQPec6CSs7lYJXouL9QKAYzmWmn5yZi6_8Gxr3O736NaBUkV21iBxjHYFRpxlWvWapI8MgqZZlzAnXoVbUydk9v96d_yvPn5bPNXJ_cqQ0Sj7lL3Y1VE9DnjtwWnptXaSoJdESyHQRc7JBEukaphPrvCuu_nxsIy39_63knGkYkvwSQWrS2UuyY-9sDpLVvfLorzXQiowVb6Hik738e0ZbWD3I842PBm1PClpR-r1MmXJwar1c4h1DuDU-CpUJ2yo7UcZKGVdWXIjZ-YASgLNhhwBIGjmTA3CUtjrohs2I9K-tr6aY60fScuybGFvCi22lQ1PBGOw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "5fa9209e-0ed7-40f1-b9c7-910b1bfcdb03",
"standardRoleTypeId" : "2c76afc1-c8c5-47b9-b7e3-ecf7f83bd722",
"createdBy" : "0b8b2211-c0f3-47ab-9966-c966c43f42b1",
"createdAt" : "2025-04-30T00:27:46.314221Z",
"updatedAt" : "2025-04-30T00:27:46.314221Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "81e07de9-e7c8-462f-99a0-0e9d73c9b57e",
"resourceTypeId" : "9c742e1c-afab-4b43-b40e-66efcdeb4589"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 53 Admin - 81e07de9-e7c8-462f-99a0-0e9d73c9b57e"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiI0NHRlRGUwOXRUUm1rc2t2UlZQQ3R3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE2YzM1N2IwLWRmYmMtNGY5NC1iMGEwLTQxZDc1ODIwODYzZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NiwiZXhwIjoxNzQ1OTc2NDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzJjMDkwMjEtNGNlNC00NTU2LWJlN2YtNGM4NTUzZDJkYjQ3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY2fSx7XCJpZFwiOlwiMDhkMGY2OWQtZDIwZi00MGYzLThiNTAtMWYzMjk1MWFkMTM5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.iOWkKI1hesiAL4orMzmb2Fnd1mh-o0gXQsexkK8jsSCjOKnwSraiJNfi5gGCrjtrSg4OGMflhxIW7yQ3wckTmFZmWPM1wO15ozU_dPiw_UoGLdiFK86vUe3lqKzFzsapwdEbvJ1D3REgy4pc6Hu40v_VzOW2EwlGSS0KCzzC_oFHThniwVZ4dIaDWg4-p5GAUjEICQyoKHhgPaPYT8WjH3AzifTvw4aUd_jXnnWWuEautq1Y8HcxR0pdep6I81_YBq9firL7UEgNNtogNY6QvilRtgroTPa89UTUfQaHuFer5B8p5V17sdejU0zaVUWoAPxDFHRLrn3mjF_o7mYulw' \
-d '{"standardRoleTypeId":"480ece82-16bf-4ab3-b469-1e9e9c93703e","path":[{"resourceId":"88bfd7b5-c7dd-40b9-8947-5e28282a0945","resourceTypeId":"9479370d-db4c-4f4f-8968-aba3c853087d"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "a03b1bed-f332-45e3-85cb-37391998e853",
"standardRoleTypeId" : "480ece82-16bf-4ab3-b469-1e9e9c93703e",
"createdBy" : "a6c357b0-dfbc-4f94-b0a0-41d75820863f",
"createdAt" : "2025-04-30T00:27:46.531455Z",
"updatedAt" : "2025-04-30T00:27:46.531455Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "88bfd7b5-c7dd-40b9-8947-5e28282a0945",
"resourceTypeId" : "9479370d-db4c-4f4f-8968-aba3c853087d"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 55 Admin - 88bfd7b5-c7dd-40b9-8947-5e28282a0945"
}
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/bcb2578a-4ebb-4c1d-ba95-0fc0a46dd589' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJSY3ZVdjEybTExdGQzYTdUazFZRU9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNmMDA1MmI4LTVlZTQtNDFmZC1hMTNhLTlhY2VmNGUwZTI3YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NiwiZXhwIjoxNzQ1OTc2NDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTRkMzExNGQtZWYyMS00MmNkLWI5MmUtNDI0YTk4YjFmMmRhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Y380ux1g9GHhoLcu5T6M1jZSiL_MoZvADyT9-TyNjy2YXt2jCzyrEbVeGnFp79kzzQJrzCf_IEoVToHP_U1pPNVYxVok50AWbVdCVnmpN4yY3w8wrI5tdx9xlEuWytAHPJcqLelIMvFbM3u_a00sdlxIQ10ZK9Y18A6MDm173WNmQERN_kMBWBGRdcIlY7X8j4gP39xbwjFyd0m1cM2EAaWODT6MbRpi0uQQg7Cz-osxDjged0y8XJNG7aQW4IpjEj0am0UWswurm8JHOhpBTrhF9tcrCd5bO6q_3T5D_kWCayB7_T80k_OGA0XcQy8-wwLMpBoM4kEX5NkI3AHuVw'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJTVl9DakcwVmMtcldnUTV6aUo5eVRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVhNjM5OWVhLTZmYzgtNGFhMi04MjlhLTc3YmI3NGUxYTZlZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NywiZXhwIjoxNzQ1OTc2NDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjIzZGI2ODAtODdkZC00N2M3LTg5NjItNzY0NDBmOGMxMjgwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IoxNBIR92oqeWvo8ahoNbfP8VBFQ5bjhnP-fYv9FS6EA3CrCpxA98xv_PdeK650kYrLT2ygMmze6hosEptQw_H72625wV0OcF0x-JPeQSvxf0DHENMJFgaPvXEMK3w3Hbii2Wd4Sw9W2TcIW_iadN_Mvvrr7ThHcNCCHbOHKePtV9EHaJuMa4d1JanrxbgfhsXk4fBGq5mIMydjU6bABZNp3Ygr-vbhf5yyHl6Vt39ij8gKkrrDREyO9drxoJeTUSNXJ30tSYq8ZbTcxKMQrX-mDCPNwe_A3wsL4RHKoVm39gYVe4hc4c46kn9p9xQH3FCcqVjwDHo5d2BvDwSH2Sw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 990
[ {
"id" : "104b0e8b-d647-43cb-a714-36b3e4ff452b",
"identityId" : "7a84c803-6178-42d6-911c-04900125e145",
"standardRoleId" : "c50f45f7-da34-47b1-b94e-b2b30cb68499",
"createdBy" : "e6ba57df-d6a8-4f2b-b222-711ae223c41a",
"createdAt" : "2025-04-30T00:27:46.074484Z",
"updatedAt" : "2025-04-30T00:27:46.074484Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 51 Admin - 6535ad69-013a-4704-aeda-dc9a6ef586f7 to identity 7a84c803-6178-42d6-911c-04900125e145"
}, {
"id" : "90b2bcc1-3d76-46ab-8bdd-60931204d8ea",
"identityId" : "def362d9-09df-421f-a696-1e32f4c17f6d",
"standardRoleId" : "3588608c-5319-499e-aa22-61f744943135",
"createdBy" : "fdb73372-7cd0-4da7-94ec-920e554943c0",
"createdAt" : "2025-04-30T00:27:47.163017Z",
"updatedAt" : "2025-04-30T00:27:47.163017Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 98966db7-42b5-409a-9f33-ff4b60a8a6df to identity def362d9-09df-421f-a696-1e32f4c17f6d"
} ]
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/04927e69-78b5-4b69-b116-41aff67e77b6' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiItR1hvTDFadVZnRlVxQTNTYTJpTVRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEyNGFkNGRmLWMzYTYtNDAyNS1iNWYwLTYzZGJhM2IyZTY4OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NywiZXhwIjoxNzQ1OTc2NDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGI2NzZiYzctYzhkZS00YjQ4LThiZWItMDI5ZjgwMzI2OTYwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.eNCVlO_DA3mU2jVtuZW6scbxCoXH6d3Cd094taijWQ3vMTsemWWs5vM0-kNhZpMKCUgdkemOM0sRYzAhdLMyvSBlohLl-ui0Yi94g8kAuMKFNAWAS8PGeOJgIoHXOW8YqZRmPs8Gu_MSXr05qsvJX_BdgFOTWN1Z9k6suUYx15SrYtmpvH7uWi9Jm6vCReQQysDAyxFv--KPUXb_5PoUErC2TCKfVH6gcQLupHn04c6-jjBvlvS83I_hZLtPdk_d3vrgE7wKk4M0p1028Z32Z874AmFTmisUYnlXdywcex9gzUsBZNE_NnCw5RvpgWbreb-yZm_A4cXE-NI-94S9Vw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "04927e69-78b5-4b69-b116-41aff67e77b6",
"identityId" : "c2b5e159-4256-4390-907f-434f4e5da1a8",
"standardRoleId" : "b440c104-354b-4cfb-921e-f7554373393f",
"createdBy" : "b567d4c8-8584-410f-8e1b-128477efaecb",
"createdAt" : "2025-04-30T00:27:47.353893Z",
"updatedAt" : "2025-04-30T00:27:47.353893Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 63 Admin - 589fb678-168f-42fc-ae1e-620000eebb12 to identity c2b5e159-4256-4390-907f-434f4e5da1a8"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJwcWlvS2huRl9raThHd3hoazJuSVlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZkYjczMzcyLTdjZDAtNGRhNy05NGVjLTkyMGU1NTQ5NDNjMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NywiZXhwIjoxNzQ1OTc2NDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2Y4M2I4MDItOGUyOC00MGRhLWIxMWQtMmZkYjdhYjYwMDM4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fSx7XCJpZFwiOlwiMzk1MzY3NDQtNjY2YS00NmQ2LWJjZDQtNjQwMmRjZWEzMDkxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.J8gTnMOjk_iUZvRm7rH7JdZYoqLBjytRE6FcY_3I8Xb0ONhUpeoF7nJa3zCQ__VcXbJT0fL_Wf1npfVkfcbDm1bv3IedYC8pKOD5Hpuh1ct_zHs_kL4BglqfFE8zXt6-OA808ZXeULwqq75lGyKUaW-sQbXNOSG-sI5SflQ5RtkWi7eqIhQXkroMe214rUeZIrJ2M8ojjFiNCWfjWfn6hu660mGl5DUF00aBhrvFtq0voXqLXmUBnq2lUsHV6mtY7zB-IAInt81BwxDem1rSbyHvVYmtClIhhyGPnfR7Z-wHP5gdXetmozGVGsqRrB4ZrE2WYxY_KxwlsRJbdB0-uQ' \
-d '{"standardRoleId":"3588608c-5319-499e-aa22-61f744943135","identityId":"def362d9-09df-421f-a696-1e32f4c17f6d"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "90b2bcc1-3d76-46ab-8bdd-60931204d8ea",
"identityId" : "def362d9-09df-421f-a696-1e32f4c17f6d",
"standardRoleId" : "3588608c-5319-499e-aa22-61f744943135",
"createdBy" : "fdb73372-7cd0-4da7-94ec-920e554943c0",
"createdAt" : "2025-04-30T00:27:47.163017Z",
"updatedAt" : "2025-04-30T00:27:47.163017Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 98966db7-42b5-409a-9f33-ff4b60a8a6df to identity def362d9-09df-421f-a696-1e32f4c17f6d"
}
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/749a0b11-0d64-46d2-9d5d-99e34bb76d69' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJPOFE0VUwtQlRZS0NEeV9vaVBlQmJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJlMmY2Yzk4LTExOGQtNDM4NS04ZmNhLTMyZDQ4ZjJlOGVlZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NywiZXhwIjoxNzQ1OTc2NDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTkxNDRhODgtNDNiMi00Y2JmLWJhMzYtOGZjYmI3NzBkZTlmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jtLZ33AdBehA0X9Eq9N5mND-eNLmrz5g2jm8HmnlveOA0iqd-uL3W8kZFY1J1gsyD5bs_uQxhR5k7z6sDRymzanBH_wQvC96lCWPGf4FH3jCCXh_BbYSHp_gJn9fwtEyYLaZJaSH_EodLrwFWrKwElMdaaR0hSxHf2N16EcZF27i0p58_bt6NJOdYNJrgle2e5x9oLHG2OXZ0AhAkTu5axk9W8LNHYv52l9sEzBhaf9VMqvyFxnc20acfVZlbSeGFNwvbENqMT5rAq0o0TSdQKxH6U_FtkNQ2vj7kCEiVWGWwGS9MhZLUzECe0nlRkSC4EV14OsJQM53_AEsYQ3SCw'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJ4TmhfaDRsZElwRl80SlBwSFBpbFVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEzZTg0ODI4LWU3NTYtNDEyOC1iNTJlLTg5Y2VkOGJmY2YxOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NywiZXhwIjoxNzQ1OTc2NDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWIwZGZlNjEtOGQ1OC00OTVkLTg2OTUtN2EyNmEwZDZhZDUzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DVYGfnHo9UoCTRpuSZZxGnuYAEbESwmVZvCDxRDr10JNxEyPnpbv79t8sPTv_0Zz-wwDM6Fd5nowX-fjHQyQYAzr1w1EGF7WUVF8kotAq14-CuX7tLUH8y99HeTIFyvpGKnx-hW5tUpAclyK-yheFMT8Z0RKFYPAbq0cWVuotfXvnDKXIBS4swbeCAG-CL8PKLbbfjd2mcIHq0iMY1DouMvnoby3EP9woo7hL91rPuelTS5YfUYGBbY1Oe0Zgr5ajWkbRh5d09Gmoz8Y6p_ilTUcaP6slHz4em5dSgiFLeCUG2EVfckrl4QPDHvxeNCQ8YhPGbazHwfWukC0cGT4fQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1022
[ {
"id" : "e1522122-cda1-4f70-bfc7-65591d743121",
"resourceTypeId" : "e14c9d80-17cb-4229-9536-723ce9322dab",
"authorizationStrategyName" : "Admin",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:12.113983Z",
"updatedAt" : "2025-04-30T00:27:12.113983Z",
"_title" : "Network Group Admin"
}, {
"id" : "6ed9cff2-1c5a-48f0-a6be-c905b696de8e",
"resourceTypeId" : "bddc23a0-8742-4e63-b25b-8862c6a73019",
"authorizationStrategyName" : "Admin",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:16.823655Z",
"updatedAt" : "2025-04-30T00:27:16.823655Z",
"_title" : "Customer Admin"
}, {
"id" : "58deaf51-4d56-4a84-a733-d3189019f362",
"resourceTypeId" : "2529bc81-9c74-4b77-9f56-33386216b3dd",
"authorizationStrategyName" : "Admin",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:15.178491Z",
"updatedAt" : "2025-04-30T00:27:15.178491Z",
"_title" : "Billing Account 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/33b159c5-a91c-4f8e-85df-afdcb8049ff8' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiI4ZXJUclM5S2FtRXUtUWxZR2hia0lRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQxNzQ4ZjE5LTBmZGQtNDkzMC05MzViLTljNDZmYTM3ODM5NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NywiZXhwIjoxNzQ1OTc2NDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTIzZDkyMzctNzUyMC00NWVkLTg3YjQtM2VjYzlmMDRhZDc3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Vmj8N5SWdf1mK-pzHu212m2CDH8WeZtVRxi2lybotn3C6cPcQSOdz1z71UnoT7Q9sseP0LuPxQwJw2lUl-SSznlkW772yPgtX5SbFMvOLIKytum0-JvLCYI94QNGb55Dv9CpuV03ilXdVp06c5S4wNMN2JZQX1PHgw8Z3pcGYlbyZZN_E3Mv54lodKdhD0RqUQMP6QLZRkwu4UAvMuYHu_-iZn7NXZ_F0l8mTfSRVhBHS3c8HXb6GRvMx2bxxKksLRcld1zkYQdhYDA63S9GQj6j4JNBu1rug2BXheK-RHAQ_MQ795rv1Q3x265DqUw47QnS4clwdvjQQDgdQOBkLw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 338
{
"id" : "33b159c5-a91c-4f8e-85df-afdcb8049ff8",
"resourceTypeId" : "ac59d7e7-b458-4bc2-b819-f066a9833aec",
"authorizationStrategyName" : "Admin",
"createdBy" : "59f95c5f-28c7-4a5c-81ae-60e7f87ae368",
"createdAt" : "2025-04-30T00:27:47.752671Z",
"updatedAt" : "2025-04-30T00:27:47.752671Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJFb0Z4M1kyd2JucXkyeTZ1QTFCNC13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkxMzY4ZjMxLWExNjQtNGI4MS1hMjNmLTE0YjBjZjgxZTMxYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg2NywiZXhwIjoxNzQ1OTc2NDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcIjgyMTM4M2Q1LWNjMDEtNDcwYS1hNWUyLWIxMTcxYTY0ZjM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImU4YmI2OTA3LTk3MGUtNDFiMy1hZjFkLTdiOGFkYWU0ZDAwYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg2NH0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDcyZDVmMWQtYTA2ZC00ZDc2LTgwZjYtZTYyNTQ4ZmE1MmM2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fSx7XCJpZFwiOlwiOTE2ZDUxN2QtZjBlZi00MjJlLWExODEtMmE1YjBlMGE5ZTkwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODY3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QkcZ2yzAT8aqqwLgXbrb_B2_b0-Tp_LgJ1mVl94Mo9Bq6RDB73D0FlQV4SCvAmFrimrMQu0zyFhejqsRapbNDzls6Eo-26I6tcX-JRl5u3MX20R-pa3STgSZV8cwva1LOD5gTPQRmbHsz_BfdZoOdwmzVlYWWPmwDXHvw1ljRl_s-EW519x-QQl9l1s-OAFbfwGpWKVxqiWjQww56M1_jilleQTrH4CYLdlFP8oPcsfMP636Okf2RVP_TDz8fNuGAa4wtIwVV99u2AlrTRHEdrXaZ6lXul1R0BakoQJliGUMgZ-T6sSBa0bQFeDdT_s2pbSHWz58F56nvHNenL4vGQ' \
-d '{"resourceTypeId":"07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c","authorizationStrategy":"Admin"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 335
{
"id" : "1c644b70-8a48-494b-a7ca-3237a4931eaf",
"resourceTypeId" : "07b3e4b3-11fe-4b17-b7cd-f5c087aa0e8c",
"authorizationStrategyName" : "Admin",
"createdBy" : "91368f31-a164-4b81-a23f-14b0cf81e31b",
"createdAt" : "2025-04-30T00:27:47.646449Z",
"updatedAt" : "2025-04-30T00:27:47.646449Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJFSXpxMFRwSnNnOFFoeThZN0JmZmt3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjYjUxZDQyLTg4NTQtNGM3Ni1hMzMzLTc3NGQ5NDdmYzNkZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg1NywiZXhwIjoxNzQ1OTc2NDU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWQ2NzBlZTQtOTJjOS00OTU1LTgwYzQtODYyZjFmNzZiNzc5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODU3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jar1y9TPPGjVcua82D1ZEP6ihtxg27Zz2ckxqh2i9n9b9HseSZ2hux2VEoBzv6uW15VOGyggKa72IGSF2DUB6TZiPA1AmjuJfkfwJC_7sshEmHskspziqF-01x8aC99qop2Kz0IbCsxqyRkAzSE9yx2cIVNLplu1VN87MzaglJ10HQLT9wBqRraUUsLrpnfmt325DLyM_vWJs0cY9Zu7qPyrbZ-SzM3p8tx8USUJ_aWI_3Bn3B8RLZEG8VjV0PQRdHbzUNAeUFQzaYdT5S1ZK0wb0GiC2Wzp1e0CqSbmTZpPNkBQAw9djVZYKFxLqWW_0Kdea5YKUEGsDFmUR199iw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1571
[ {
"id" : "1f5426b1-7e34-4629-8a94-b2448656816b",
"resourceActionId" : "67820955-f19b-4734-bbae-13ed4174ae69",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : true,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:14.075343Z",
"updatedAt" : "2025-04-30T00:27:14.075343Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Read Edge Router Policy in Admin Standard Roles"
}, {
"id" : "922c731b-0e00-427b-a073-8821fb25369c",
"resourceActionId" : "09333aa3-0f65-4b92-973c-0b4ea2dbd51a",
"authorizationStrategyName" : "Read-Only",
"includeWhenAbove" : true,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:12.581053Z",
"updatedAt" : "2025-04-30T00:27:12.581053Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Read Healing Alert in Read-Only Standard Roles"
}, {
"id" : "11cfae7d-58a8-4def-8720-e6b6b80e6b4d",
"resourceActionId" : "dc4bd091-1a0e-4de0-a0b5-f7edf218468e",
"authorizationStrategyName" : "Contributor",
"includeWhenAbove" : false,
"includeWhenAt" : false,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-04-30T00:27:13.322473Z",
"updatedAt" : "2025-04-30T00:27:13.322473Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Delete Data Center in Contributor Standard Roles"
} ]
Get Action Inclusion
GET /action-inclusions/{id}
Authorization
This endpoint requires read
action on the action-inclusion
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
authorizationStrategyName |
String |
true |
Must not be null. |
includeWhenAbove |
Boolean |
true |
|
includeWhenAt |
Boolean |
true |
|
includeWhenBelow |
Boolean |
true |
|
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions/4b4aab7c-dddf-4cbd-a7ad-ba142e854911' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJWWllNZEJJbVRwXzZoWlUtSmU5VlN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUyZGY3NTk2LTE0NWYtNDk4My1iZjcwLThhYjFkZjgzZTZmMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg1OCwiZXhwIjoxNzQ1OTc2NDU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTVkYzcyYTMtZGI4Yy00NzBjLWEzMjItMDUxM2UyYzQ3ZDVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.OA5sGIDRkv0wYKKRRWPrJazoE9JY1a-0vGSzGKKSp5juFpcPZs8LKDFr7pxefac8Grzp4xByCFlasdDdi-UYN0HZ58f8My4S0HStuAa_XLWsAiZlDI8PHG22eAUMLjT8JyLQU813YqDV3lNvqUUbYvvEMRm-3o64moSbrmIp85MaWovAgH3HKM0VtU9ymK4cuuwJG9hfJdkJby3gmv789G3loT7YocONhF4sI1h4PXUzhWJ0JpTQGTstRhBQjqBcRYOKgKqdkWPBEyFbXIw8BNYMANDhAdD_X-1NGJoZamuTwMQAthn0GmVGdZdoYFAOxjslmCiNxHowFpme9kEkpw'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "4b4aab7c-dddf-4cbd-a7ad-ba142e854911",
"resourceActionId" : "b6609bd7-bf83-488d-bdb7-7ee5d5128a20",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "3802b0c8-2634-47c7-90d3-1050f36811d9",
"createdAt" : "2025-04-30T00:27:38.750574Z",
"updatedAt" : "2025-04-30T00:27:38.750574Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJGTjVLUHM0UGUwblktc25mWHZzaFBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUwOGZlYTE3LTY1MDUtNGIwYy05ZWUzLTI4Yjk1NmZmNjA4OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg1OSwiZXhwIjoxNzQ1OTc2NDU5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGQxYTZlZTUtNGJhYi00OWNlLWJiOTMtYWY2MTA1ZjVlNDY2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODU5fSx7XCJpZFwiOlwiNzg0OTJhNzEtMWY4MS00MjQxLTk3YjgtNTVkYzBiZjZmODBjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODU5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QyBST2GPwH8bxaEKeSSZZktpAj2iCM2tIrHXsHkTLU9RnDWQIXN3iOP5ylZnFcSpEOLwvaW1IPnX7fFK1aNEsMP_XATzAI3aIjwTEtfg0mEwOXMmuN2LnhqJuvC6mmyi3UfOjhkOlHvhSgawcfuDsjLk2WcE0BvMWMYDeYc15E9t6IvMaogbKs3Q7z4Q3EToM7ufVZjjutD3Rb9EafDz4R2gGVRlVF1xmkmv1r9qso8oJhV5_BWdnsmT6KcRKT4W4jqb3y_JjyYpgSJoizEyBmNQbJdnJ41P6G8T6EmLbHafEkeGtaDhhF49Wqop07ZUwemlvJwnxtNJarNPfMLQKA' \
-d '{"resourceActionId":"a6f298a0-1060-45c3-9595-d89f2261149d","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 526
[ {
"id" : "6e0d4d7e-c59f-4a53-b170-d8ceef2a965b",
"resourceActionId" : "a6f298a0-1060-45c3-9595-d89f2261149d",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "508fea17-6505-4b0c-9ee3-28b956ff6088",
"createdAt" : "2025-04-30T00:27:39.534298Z",
"updatedAt" : "2025-04-30T00:27:39.534298Z",
"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/79094a76-8011-485a-92b6-76718dc2f2a0' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEwZGViNTQwLWNkZTMtNDZmNC1hNzEyLTE5ZmNmYmMxOGQ4NCJ9.eyJqdGkiOiJpWXFaR0RaMmxvYmNHNDd5akpzSUxnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUxYmQxZWIyLWRhM2UtNGNkZC1iNGU0LTA5YmNmNDFkMjQ4NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NTk3Mjg1OSwiZXhwIjoxNzQ1OTc2NDU5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjFhMGFlMWM1LWNmMTItNDU1NS1hNzc1LWI3MzVkZmI4ZThhYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc3NzQ3M2YyLTVhYjctNDQzMi04NTk0LWY0ZTUxNTVhODE4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNX0se1wiaWRcIjpcImM0NGZlY2JhLWIxOWQtNDlkZi04ZjQxLTYyZTQ3NTNhNTJjMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjMzOTQ2ZWZlLWZlNGYtNDA4Yy1iNjYwLWJjZGIxMzRjZWY3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjc2NmUzZjBhLWE3YjMtNDNhYi05NzcyLWU0YTVkNzUyYmM2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3Mjg0OH0se1wiaWRcIjpcImZiOGZmOTU4LTFjYjktNDA2Yy1hZDNlLWE2ZWUzYjYzZGJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcImExMmMzYzEzLTA4MGEtNDIzNS05MWI2LWU4N2U2ZTlhYjg5MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcImE3MzEwNjY0LTY1ZDUtNGUxYS05M2VmLTQ3MjBjYWM5Yzc1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzMn0se1wiaWRcIjpcIjU0YzRlMzkwLTU1NDctNGE4NC1hNDFmLTU5ZGNlODNkYmNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzNH0se1wiaWRcIjpcIjc3NTE1N2YyLTVjYjctNGFhMS1hNTFiLTAwOTUzMTdhYjFkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NTk3MjgzM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGMyYmFmN2QtYzYzMi00NzhhLWJlYzgtYWNmNmQ5MzFiNjc5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ1OTcyODU5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.X2OO6JmukYPdypwrtN0eQlJE-_F3bkXaIbCijBdY4BQxjhE8N-8pUjGTD_ZJElwKbzp_LVy6t8qrNGPKg1PLEk-6v1TI2Ea2Avf-c843-tbh4LjpXzPn_ba8lTAFfcFW7VhcYwCWQ3Cz_hfMgpqVHDbV8b6JjGN8cSt_Fn8cauVLKs3nigyh-Tu0Y-9F57om5r3pNO2yf3DNHD1blUCk8UEffDKjWQqKqdqfpKKL743bghior7-vzpTDehm2hPVScCHR3XoXDLyIglpc6bxQl8uwN2JrYoiWlDQhpkC9nejQk9QllRyApySuju6uU839IVSDQynYFHS_p6komTN5ag'
Example response
HTTP/1.1 200 OK