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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJNLVNfWHdjUjB1ekJPRHZqaExqX3VRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIyMDdkNTliLTFlNGQtNGM3NS1hODc5LTRhYTM4OGZlMDVkOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MSwiZXhwIjoxNzQ4NDYzMzUxLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImIxYjhhNDNlLTk1ZDAtNGViNi1iMGE3LTBjNDI3N2FiYzU0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1MX1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNTg2NWI0NmItZWY5MC00MmFjLWEwMjUtZDk0ZjMwMmMyYmZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiZjg1NTkxYzctM2E3MC00OTg5LWE5ZmUtNWU2OGVjNzMwMTMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiM2M5NTY2M2MtODhmZC00YTc1LWE1OWQtNmJkMTlmNDkyZGEwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIzfSx7XCJpZFwiOlwiYTIxNzdlZGItNTcwOS00MGU0LWJlYmMtZWRhYzQ0Y2JkNTRlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiYTBlNjUwNTUtYWY0NC00NGI5LTgzZDQtZWUzNGI5MWI5NmI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiODVjNTIzZWUtNzZlMC00NmVlLWJlYTEtNTA4NDU0ZjdlZWIzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiNWRkMzI2NjEtZDgzOC00Nzc3LTkyMDQtYWRjM2FkODEzZWE5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzI0fSx7XCJpZFwiOlwiM2ExNjEyZWMtNmU5NC00ZmJlLWI4MjYtZDhhMDc1YzA2YjQzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIzfSx7XCJpZFwiOlwiODEyMjJlNzgtMWExNC00ODIzLWE4ODAtZTRlNDg3ZGFkOTA1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzM4fSx7XCJpZFwiOlwiYTY3MjY4YjMtNjBlOC00Mjc2LTgyOWYtM2Y5NmIwMGZhM2RhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzI1fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.xK7OxW37OvPr_WYkQOWy8PgVLDbvqsV56GlHjRL1MvlDgqrhqHg4ErLfsF4sTQ1qL-zFCMlXgqda2AsD5UXE44TFxoA56znn-l4IlHGeFdmM6_mT5BL80GCfjnsOO1gZGkiOpMEmPuLj1xXjTgMVUFkiECqlhOXcDWArSguzxjgD0IXSTyfWuus2uGGcFynbkD-_r3JLVoYlx1vQRF1liALkTaN-fz2DthWqSJDsGYXZBxvDkMu7QGQbBvhD9Z-zh3-FHOCbhSaNAl-YZYiVSGw_xfLs82UIM6QZEscTdVOEN_UdrIj9TWzv6DNkNbQOoJlE62AQW2SuoAv9U46lcg' \
-d '{"identityId":"e3dc4aa3-6b33-4293-8007-d61426dee7c8","audience":"io.netfoundry.test","claims":{}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1950
{
"token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJGYTktVVN5MnlOMFkzbnZvZEltczZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUzZGM0YWEzLTZiMzMtNDI5My04MDA3LWQ2MTQyNmRlZTdjOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTc0ODQ1OTc1MSwiZXhwIjoxNzQ4NDYwMDUxLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjJmZDMwZTA1LTEwMTktNDVhYS1iYjJjLWQ1MDIyMmZhZDA0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNTg2NWI0NmItZWY5MC00MmFjLWEwMjUtZDk0ZjMwMmMyYmZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiZjg1NTkxYzctM2E3MC00OTg5LWE5ZmUtNWU2OGVjNzMwMTMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiM2M5NTY2M2MtODhmZC00YTc1LWE1OWQtNmJkMTlmNDkyZGEwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIzfSx7XCJpZFwiOlwiYTIxNzdlZGItNTcwOS00MGU0LWJlYmMtZWRhYzQ0Y2JkNTRlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiYTBlNjUwNTUtYWY0NC00NGI5LTgzZDQtZWUzNGI5MWI5NmI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiODVjNTIzZWUtNzZlMC00NmVlLWJlYTEtNTA4NDU0ZjdlZWIzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiNWRkMzI2NjEtZDgzOC00Nzc3LTkyMDQtYWRjM2FkODEzZWE5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzI0fSx7XCJpZFwiOlwiM2ExNjEyZWMtNmU5NC00ZmJlLWI4MjYtZDhhMDc1YzA2YjQzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIzfSx7XCJpZFwiOlwiODEyMjJlNzgtMWExNC00ODIzLWE4ODAtZTRlNDg3ZGFkOTA1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzM4fSx7XCJpZFwiOlwiYTY3MjY4YjMtNjBlOC00Mjc2LTgyOWYtM2Y5NmIwMGZhM2RhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzI1fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QoaZ1bIGE1ECqBxqnJHn0P9OmW_4zV1zqXqc0CJJ6tJRkfJM7WFb_p8mD7sMTwgBNoFyL8WcmnxTjXMOiuxG8csWRgzitaCfX5AYFcvIUh84lJMZchBerbV-dXr0uoVEnK89rqeSAzAwqoasHTGmIR5SqUgJG0-G_byz6lM-DYU98A2xsHzb3iPIg3ItPTA3inxzltDMqdR2cWF6fobya9Cp_PC0ppQ3FnjkB83WzLjQCZEfKMfSM8uHpb1-vCzwssH86BtUvVhcGScgbIxn9p9hGBXTtEqA4PDDRKRgo6tL-WindcZVZFCBQv0mdetT5jgK9aKrrntNTgd0__zJcg"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJ2SklPcVpfRU5faFZjSFZxZ1lFLVNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ2NGE1ODAwLTNjZmEtNGE1NS04MDY1LWIyZjRhNGFkMzczZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NCwiZXhwIjoxNzQ4NDYzMzU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWUwMjU0NjktZGM5NS00YWNiLWI0MGYtODRkZDZjZjQ0M2FjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.iUSvVdFgZiqNw6-57eLrJL0QCdii4pN9P5H7T9GyNRMLgGwx5bM_iKX1krUgp3XuQw0MgRXeUuz1AIqyR3Bg2N-n39rv8TiiaNOfFeUD-Yq1sxcIFnYsTsHY5xuZKYcbjsCPoz6lAv96bWpm8ajzWkxikCqE0gCujakGYvRKxMTVpn21IbOkj-V29JgQmKvWTHNAnpJCQE-KPgFSdFqd7s6PY9qxdjYFMbfFkaR5b2N5HN0k2DelndqHE_cfl9RQ-1psN0r4g9-CSJDFnldX7DwCRePP1DGN9fjSLVreNuUWjPhhGCZ4bDEcBXCpfURk-JUxZbExB4UMgsyent0s3Q'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 872
[ {
"id" : "b34f2d3d-da4e-4760-af97-15468b3300b5",
"name" : "Test Domain 3",
"code" : "test.domain.3",
"createdBy" : "4f68e491-08ca-4f1c-a657-f72df5b75776",
"createdAt" : "2025-05-28T19:15:42.988048Z",
"updatedAt" : "2025-05-28T19:15:42.988048Z",
"_title" : "Test Domain 3"
}, {
"id" : "ef4526f4-976c-4aaa-9757-571be4dea3f7",
"name" : "Test Domain 24",
"code" : "test.domain.24",
"createdBy" : "6a85adb1-a178-4c5e-b2f3-b5762cb43e5b",
"createdAt" : "2025-05-28T19:15:52.211271Z",
"updatedAt" : "2025-05-28T19:15:52.211271Z",
"_title" : "Test Domain 24"
}, {
"id" : "2e0fccb3-f236-4543-9e33-82574ef86285",
"name" : "Test Domain 7",
"code" : "test.domain.7",
"createdBy" : "40be8734-5b60-4398-8421-c57c9e7e3e44",
"createdAt" : "2025-05-28T19:15:43.085798Z",
"updatedAt" : "2025-05-28T19:15:43.085798Z",
"_title" : "Test Domain 7"
} ]
Get Domain
GET /domains/{idOrCode}
Authorization
This endpoint requires read
action on the domain
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
idOrCode |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
code |
String |
true |
Must match the regular expression |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/domains/471cf0de-9430-4a17-9a0f-aabfd18a463c' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJEdUd0em42dnE2a2hyTUZpaHJwSmV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRjZTFhZmY2LWMxYzktNDlhMC05OTk5LTRiOWNlOTZmMmE0MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NCwiZXhwIjoxNzQ4NDYzMzU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTRmYmI3NDMtMzU5MS00NmY0LWE2YjktYWI1NTg4MDZmMWRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Kc0URPQaMGLvV7Ye7Nfu3gm69a24ijGMbs_AX6Pnr5EJC2inIPHGZCC_NGdrRtbDsxxVF9Fo5pQ31c0JKzKKI1o1ydNwBCI60Gmue4YGLalPI28SUgWFgVfhUJKTy7niOsV_hqRrIKncv7rA3ew-_stpvDg5vP4TATtQFNABDKN3x_FcM4wLUhbvpACh7ESAfzlS05jQOqgehY-NlSHeCGq_hhmUdvTcUCslsOxY4VpO2gjnxM8ZHk8gG_8sbsWAUBe3qVdP_KnTlXX5JPxvogaEgJgaWt0TpImy4UYnpkRMnvV7QyCeQbOtEzxylkqbRKMy_QNntfAt2xcP7dd4MQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 288
{
"id" : "471cf0de-9430-4a17-9a0f-aabfd18a463c",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "85aa0b79-2a75-4b24-9f54-65bf5ff72840",
"createdAt" : "2025-05-28T19:15:38.546868Z",
"updatedAt" : "2025-05-28T19:15:38.546868Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJ0WnNqblByd3pJbktlTkt0c0tFRzd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI1MDZkMGYxLTE4MGEtNGY1Ni04YjVjLWQ4MmU0ZmU0MjRmZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NCwiZXhwIjoxNzQ4NDYzMzU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjAzNWYzYmItOTAxNC00OTEwLWE3ZGUtNzVkZGQwNWQ4M2Q5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.AyXSJJ4MXshtXW3Hsxx7TM3SOpYsCeYYkDRPczt01gafHEYe7uqlLBrjv6TV2-KPp8c70i3eaHMRHpFphUyWm61q7URabjJd8lgY6QBpqZwspu8rbNstrtmO5Cub8ZowDLQxPRKeJgiXYwmBe5FDSiUXDcdVhvUK-ZMBTHEDYHS72wML6ivj_CogbRrQz0IzmcRHFqu3OYt6PWCV1nFaQMRVhZy4yT1OW2-v4MW634U5TtOj4yW6YloluVE6vimT9T9WtBYo4YnGyNtWmB9jUpnBbmzLdf9Ldj974ZuDlALecZj5Duw4Zln9tk8V0kf8ioWxkUxKLe1JS-rJCMvE3A'
Example response
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 288
{
"id" : "471cf0de-9430-4a17-9a0f-aabfd18a463c",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "85aa0b79-2a75-4b24-9f54-65bf5ff72840",
"createdAt" : "2025-05-28T19:15:38.546868Z",
"updatedAt" : "2025-05-28T19:15:38.546868Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJhZ3RQRmk3Mkc0aFBFRjZMQVVDd0JnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE5ZmNlZGUzLWU2NTgtNDE0NS04MzBiLWY0ZWVhODI0ODRiZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NCwiZXhwIjoxNzQ4NDYzMzU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzllNmIyYjYtYjJhZS00ZDhkLTkxY2UtZTczOGM5ZmRiZWZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.M04oGCHZlNBfXAetGS1YiGV5Ldae3k0nWbEhCdGvjW14FEIR7g55nccLWd4Hio4AbfiMwB09pRRNhfRLm8DEU9h4HruizBv6m8ddf6PQxrZ2cbClfYl6Ur_dpI7zBIq-Xq9kkshpvVVAoG1enuoyxvGx61bCnJJmW7wuRpib-MnVH6OnM2pzRA7pVcOM27SDHWjK7ssT9-Vx8_cd1VW6srk52Tcn8Uy7bXTbl980EMWDN733D2xzI9LsWJ1l6OVPL5RDonM1EZcr9HNJlIMEWxxDYYkw7PWNGcbqv6FG6xXAJi5lqdwbrw0Q5H3kw03xD1Y5dkC5qfN5h8ePkiAlrA' \
-d '{"name":"Other Test Domain","code":"other.test.domain"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 299
{
"id" : "7d8a398d-5615-4499-8335-2ca6c7d35dd8",
"name" : "Other Test Domain",
"code" : "other.test.domain",
"createdBy" : "a9fcede3-e658-4145-830b-f4eea82484bd",
"createdAt" : "2025-05-28T19:15:54.721056Z",
"updatedAt" : "2025-05-28T19:15:54.721056Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJEZnB4VUZhU1ZKTGpwclJtc3FxNVdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFkMGRiNWY2LWQ0N2ItNDdmZS04NWZiLWYzMTQzNGQ3ZmZjMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NiwiZXhwIjoxNzQ4NDYzMzU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGUxMGM2NmEtOGRlYS00MWM3LWE2NjYtYWRhM2IxYzBmYTY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.hN-AGdR0Hx1H90YI6_gwpIDkyNct9H5wWbfjtWUtQE_25t02fa5PJ1Ts8gEGVwaxkFYH32h7uOGSqgdUdKgQm13vMAmgjxVyk0oe9YbpHa8Q_eX7tGOAKHDi3xRo65RUAHiHD52sfpy_uIQCu0Bmq53MfSj6l26b3gvYufTEkB2YsbOi7u7sEjIwplTZ6GRlWwrwv0yp0nf3lJ7vL9oNBUwCzGDPh5DLJzYV7yA74ecSb02hiX6Q10RE9y7qBuRmw9YjvGqV-b1vZHMCBDX8X_Mcw1ecC3nA1_IR4d-XNRVA9Iu-YnWXKu3zo6mH9eZUWbLZZCagoExz5F0bkI-18g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1320
[ {
"id" : "9f183942-8b6c-4987-8704-46195d1b44a0",
"domainId" : "f6363b66-e0f2-4e5b-a332-93dba6a07167",
"name" : "Cluster",
"code" : "cluster",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.449014Z",
"updatedAt" : "2025-05-28T19:15:26.449014Z",
"parentId" : "2e35a464-6070-46f7-8715-fcdefa1183fe",
"root" : false,
"depth" : 2,
"childrenIds" : [ ],
"_title" : "Cluster"
}, {
"id" : "7eb22650-dfc4-41dd-a71e-cd48193e7655",
"domainId" : "f6363b66-e0f2-4e5b-a332-93dba6a07167",
"name" : "Azure Virtual WAN Site",
"code" : "azure-virtual-wan-site",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:22.164507Z",
"updatedAt" : "2025-05-28T19:15:22.164507Z",
"parentId" : "2e35a464-6070-46f7-8715-fcdefa1183fe",
"root" : false,
"depth" : 2,
"childrenIds" : [ ],
"_title" : "Azure Virtual WAN Site"
}, {
"id" : "43effaa9-e82d-48c8-9fa2-b939b916f21b",
"domainId" : "a5e9c7b1-3a74-49b6-aabf-c61a2b628a46",
"name" : "Banner",
"code" : "banner",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.118276Z",
"updatedAt" : "2025-05-28T19:15:26.118276Z",
"parentId" : null,
"root" : true,
"depth" : 0,
"childrenIds" : [ ],
"_title" : "Banner"
} ]
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/62818b11-0630-4581-b542-6db692e2a258' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJfd1VreUNYNXkwbEJwVkdMVVotTDZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA4YjVkYzJjLWM5ZjktNDY0OS04OGVmLWZlODVlNThmNDkwYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NywiZXhwIjoxNzQ4NDYzMzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDEyZTllYjEtODgxZS00NWM0LTlkYjItZTZlNGZiZDNmOTY5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DQxeRNNUtMP_0HZRpuP9hto2a0KCq_noaf6ISH9moV1idkKGfwRXKvNIho1wl3zcm7ou77R0rrrBA2zJvPPGajwb3DMx5CAgEC7Kq5YlBLTKC_qwmo_AEVXa2vY52ZJnuYMKIKdalT2GwEaZKLbquy01JJ5dllQtzehiW_2YoXIbxpF4kF-NEdbCLRs5lQnazJiK1Ad-QkWjbcWJxtK_pGpJZAM7aE4dvnXWQfEYpzgl8oapH4emj8lrfnllDCNYwSZSqbW4D0N8Uvm8P6sVPbxM1DQrzirTxOADvA0nUIUn_LCnF5HYer8fbhth1-kK1cDspaCapzhKaGifVCmOxA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 406
{
"id" : "62818b11-0630-4581-b542-6db692e2a258",
"domainId" : "471cf0de-9430-4a17-9a0f-aabfd18a463c",
"name" : "Test Type",
"code" : "test-type",
"createdBy" : "66d73774-74be-4d26-8ba5-e917129eade2",
"createdAt" : "2025-05-28T19:15:38.614891Z",
"updatedAt" : "2025-05-28T19:15:38.614891Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJVVS1aQ2h4MVFWX2I2VzdBczdQckRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBkZmRmYzFmLWE5MWYtNDk2Zi05MGI4LTY5OWJlNzA3NWU1MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NywiZXhwIjoxNzQ4NDYzMzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDEyOTRiMTctMWVhYS00YjEzLTkyN2ItZWYwOWQzNzUwMDJjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fSx7XCJpZFwiOlwiMjJhZmZhNzAtYjFkYi00ZDc3LWFjOTYtNDMyNzE5NTIyYzI3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fSx7XCJpZFwiOlwiMDk0YTg4OWQtMmU2OS00ZGU2LWI0OTctNjljMTExMDQzNmJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.NIdkMXbI2aP2i9ck6pIP40qa_tWX9uB7XJ8XPvqsZbQbTbf6oF3zXCWkwXsL0Rnk4wA-aBvqwmjjOH1ivj47yTgdXrUP720u4BB_IyuhiDXFgbf-gleq4pFCj5jO6XnMfQBMC3Oekae-26rC0cgcYYDxB8zFfu4KyFAKPU6UYzhskF5kaYXiqYrAheSumzuN1TpCIv5u8umedJwiVWYntoyOpobcM1a6V7KgTHCo0FKrDPj6axXqimFy9_D-tpK6b0_ONR4PpOJj4e6nPCRZdmmX-qCWtUaSXIBoYe-ulYoERpPeQsRbk1V7ZjWqXAfAE1Nv2sYdegh3hQazIHnueA' \
-d '{"domainId":"471cf0de-9430-4a17-9a0f-aabfd18a463c","parentId":"62818b11-0630-4581-b542-6db692e2a258","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" : "250fea5a-3565-4c8a-96b7-7e59244f7638",
"domainId" : "471cf0de-9430-4a17-9a0f-aabfd18a463c",
"name" : "Another Test Type",
"code" : "anoter-test-type",
"createdBy" : "0dfdfc1f-a91f-496f-90b8-699be7075e53",
"createdAt" : "2025-05-28T19:15:57.291665Z",
"updatedAt" : "2025-05-28T19:15:57.291665Z",
"parentId" : "62818b11-0630-4581-b542-6db692e2a258",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJqWlpnZWZvMEZWc3VKd2d4WGgtM2NBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZlMGU5MjY2LTYzMDgtNDczYi1iZTVlLTkzZDQwMWJmOGZkMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NiwiZXhwIjoxNzQ4NDYzMzU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTI0YjRlNzktMzdlNi00MDdmLWE4MmItYzc1NmE2OTY2NzRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.s4N-0yxYlNELSo0droJdzGLrwN05ADgbpuLXXNvlD3qUeN1MuFfrPukODOLESF3hxvrXjAngXivsVFbRZ5ermbXrCvIqKxIXMR4N1DU49WQGD2pmfLFfcfNHqpUl8P3fYG3LNVZTJaIO_k2CDKbgIAG95qJU8MzANT9IxknQeHoJqjQnzMgj6lF6uvADNxaP4O8xmmW0iYUA5e5V_CHcmY3__w-vn7_pUGBZX1w3tOViOBAFmiU8rMW3cfP2DugWFIu5Xo_bF2_2EMitsONOohcPy-fGUVKPoLWDz_-wVFlr4J358QDSKZAm-Pby0kdW9rQma7IkXVz5b-IWyjlWhQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1108
[ {
"id" : "e300f826-5b5a-487b-8a20-a6d1b4ba6099",
"resourceTypeId" : "43effaa9-e82d-48c8-9fa2-b939b916f21b",
"name" : "Create",
"code" : "create",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.118682Z",
"updatedAt" : "2025-05-28T19:15:26.118682Z",
"standardAction" : true,
"_title" : "Create Banner"
}, {
"id" : "a60cef65-3688-4514-b2c0-85e9da60e1a2",
"resourceTypeId" : "eb756709-fe8d-4ae7-830e-040451bd41ec",
"name" : "Create",
"code" : "create",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:22.172655Z",
"updatedAt" : "2025-05-28T19:15:22.172655Z",
"standardAction" : true,
"_title" : "Create Transfer Node"
}, {
"id" : "04bf4fb9-e14c-41fe-a6e9-9b003076e6c2",
"resourceTypeId" : "f316df28-6977-4f8a-808a-cdc77775a06e",
"name" : "Create",
"code" : "create",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:22.834863Z",
"updatedAt" : "2025-05-28T19:15:22.834863Z",
"standardAction" : true,
"_title" : "Create Action Inclusion"
} ]
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/5f1a0c64-b5e9-406f-b288-99fb4201dc93' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiIxYWxuZW5CRDFjUTBpWV9rc1NvclhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ1NGIxODYyLTUwMTktNGFmNi1hYTM2LTlhMmM2MjRlODI1YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NiwiZXhwIjoxNzQ4NDYzMzU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODU0YTk5NmYtZTg4ZC00YzNkLTg0NmMtNThhZGYxMzI3ZmM1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.TSvlKQ9EssAB91vjW6Ur74NXHYhXcKcad0deAns6vFkYG9iDFxorae30-B8mLNoDwmADoDCLgSuU6fo14gBEHPShz89VOcXaSSEyp75U68rEjyprlFQHGjIzE4LI1Q83AqSscHZiCyL-MsMcXSoNxEC1ULso6Bp9fBZEqDM0qG9weG9qi_ao_xK4vC_Ow0chRq9H_mxNP7Toha7WppudFoXKp4SM20HtRoferp6M4IoQY-8Lan4hKMxUrYyNlIwyQ_mSj08PRrfGDfwkeL6pFg44Ssqo8xQBDH83Ef8xxsFEJ7W6xVdkCBrnMFuy44Q7sF2cpJwv2z6VrRkCsEo7_g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "5f1a0c64-b5e9-406f-b288-99fb4201dc93",
"resourceTypeId" : "62818b11-0630-4581-b542-6db692e2a258",
"name" : "Test Action",
"code" : "test-action",
"createdBy" : "5f57384f-4a2c-429d-9a31-84b29c86634c",
"createdAt" : "2025-05-28T19:15:38.671886Z",
"updatedAt" : "2025-05-28T19:15:38.671886Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJ6OFowT2tiZmxILVhwRFVhcDF1NkVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ5NzIzYjk5LTQzY2MtNGNiNy04OTU2LWEzNjlmZDg2ZDk4NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NiwiZXhwIjoxNzQ4NDYzMzU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjA0NGFiMDgtYTQyNS00YWMwLThmMzctNGRkY2MwYTEzNTAyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fSx7XCJpZFwiOlwiOTI0ZWNmMTctMjk2OC00YzFlLThhNTMtMWE0YzNkNzliZmUyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.r_aCJqYAXzbVfqBNc4GCNUge4UDaRmAzOPeaKuEhu2E70Haouw6S6VrajFpo2VQ4l__wMytpM5it6ySKrlYC0PcJW27W1u-8n_A4iTL8K6AhSWGv9064ArQk98hgrQwQI34kvj9EL1eDCbcDxK4y1etL8BTpLaZK0RgYBRTvhINMFjgR4sQeGIhD028GUjkf7xhBd_aqnHJt3J05vGCRcBeP8gb8d_8FFxfGDDKtKWO2Z-xyp0kDmBa-nIJyE-rrxXJHLvaCxKmYvmX4wCD5MoAawHwgWFi513epZHlEfX_TgvutqDHjpybql-aYFHX6RmSlaEEZEZj-s3qIAVemDg' \
-d '{"resourceTypeId":"62818b11-0630-4581-b542-6db692e2a258","actions":[{"name":"Update Custom","code":"update-custom"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390
[ {
"id" : "53965d98-4aa7-442a-b02a-1e49829bb160",
"resourceTypeId" : "62818b11-0630-4581-b542-6db692e2a258",
"name" : "Update Custom",
"code" : "update-custom",
"createdBy" : "d9723b99-43cc-4cb7-8956-a369fd86d985",
"createdAt" : "2025-05-28T19:15:56.584915Z",
"updatedAt" : "2025-05-28T19:15:56.584915Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJnOVpXdnlybUNpQk1MTG1sOFUxd0hRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZmYjkzNjkxLTVjYmQtNDEyNy05MGY2LTAxZmUxOTc1MjcwMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NCwiZXhwIjoxNzQ4NDYzMzU0LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImY3OTkyMGRjLTEwNjItNDg2MC1iMzJjLTcyYzk2YzM1Mzk1ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNTg2NWI0NmItZWY5MC00MmFjLWEwMjUtZDk0ZjMwMmMyYmZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiZjg1NTkxYzctM2E3MC00OTg5LWE5ZmUtNWU2OGVjNzMwMTMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiM2M5NTY2M2MtODhmZC00YTc1LWE1OWQtNmJkMTlmNDkyZGEwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIzfSx7XCJpZFwiOlwiYTIxNzdlZGItNTcwOS00MGU0LWJlYmMtZWRhYzQ0Y2JkNTRlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiYTBlNjUwNTUtYWY0NC00NGI5LTgzZDQtZWUzNGI5MWI5NmI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiODVjNTIzZWUtNzZlMC00NmVlLWJlYTEtNTA4NDU0ZjdlZWIzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIyfSx7XCJpZFwiOlwiNWRkMzI2NjEtZDgzOC00Nzc3LTkyMDQtYWRjM2FkODEzZWE5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzI0fSx7XCJpZFwiOlwiM2ExNjEyZWMtNmU5NC00ZmJlLWI4MjYtZDhhMDc1YzA2YjQzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzIzfSx7XCJpZFwiOlwiODEyMjJlNzgtMWExNC00ODIzLWE4ODAtZTRlNDg3ZGFkOTA1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzM4fSx7XCJpZFwiOlwiYTY3MjY4YjMtNjBlOC00Mjc2LTgyOWYtM2Y5NmIwMGZhM2RhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzI1fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EK6RIF0tEs8KAegzY8ehcpQ4ij9SHoOQRH_018FSzei5lsutvLV83kiib7chFSOHjYK2CkeAFV3WCulNuzaYfBc2YdiFarbWzNqPNDe0UXIKOUhtyxZJ4Sbpqi7SfvtCUlEsQSDc8NFmoNxKIjYb2rvkN_4PU_3jhjhawpxv8Vlpt8WxZo9q-B25Rls0SbKdJ3vCxG7BbFHYhNawOc_h_HGhZC8VdjOWtdN76BElwIXVwjmqgaX9LBSBhh8aTb-F_RVU2uVrORImxqHsMaOG606E5slKmx3eM9eRgnnoGH16ukI7lgpb7JpnOF6T84al6bkVasjQw1N_TroDF5b94A'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1782
[ {
"grantType" : "IdentityResourceAction",
"grantId" : "8dd9c27d-8bd0-4c49-99ad-e928b84fc414",
"privilegeSourceId" : "8dd9c27d-8bd0-4c49-99ad-e928b84fc414",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"privileges" : {
"io.netfoundry.billing" : {
"payment-profile" : {
"create" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:25.217135Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Create Payment Profile, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "a92dc4d2-b3a1-49a0-a391-c341c3ffccd0",
"privilegeSourceId" : "a92dc4d2-b3a1-49a0-a391-c341c3ffccd0",
"identityId" : "5be2b0ad-6c00-4a46-bd48-2dfe2f1d868b",
"privileges" : {
"io.netfoundry.auth" : {
"resource-action" : {
"read" : [ [ ] ]
}
}
},
"createdBy" : "498cd4c7-ea8b-48b1-b955-ae11538ddb53",
"createdAt" : "2025-05-28T19:15:51.314839Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read Resource Action, All to identity 5be2b0ad-6c00-4a46-bd48-2dfe2f1d868b"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "1a9bea58-5f71-44ea-9699-5478088ac4d8",
"privilegeSourceId" : "1a9bea58-5f71-44ea-9699-5478088ac4d8",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"privileges" : {
"io.netfoundry.identity" : {
"api-account-identity" : {
"update" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:22.811999Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Update API Account Identity, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
} ]
Super-User Grants
Find Super Users
GET /super-users
Authorization
This endpoint requires read
action on the super-user
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
identityId |
Object |
true |
|
domainId |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].identityId |
String |
true |
Must not be null. |
[].domainId |
String |
true |
|
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].type |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/super-users' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJlRm44UTF3T1BVdzU0Q18xNVZ4LU93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImExN2FiYWEwLTEwMWYtNDEyYS1iNjhiLTdhMGMzYTUxOTA4ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OSwiZXhwIjoxNzQ4NDYzMzU5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGU0MjA2ZjQtYjU4Yi00ZDRlLThhMTctMzlkMDIwNGFiOWQ3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IkrVL-vKuIfx6LIMQz423WpdJRLXDSOQWKS_Rug_DobnxN9Eb4G24u3A5kXMr2_xKO_zRViHduhYSWGlnkTY3t6NlrAhnr2B85effo1-fJBHrwIaErdNHvJqp-6ymkIvSYk0qF7V4MPzX9JxnEQif1aJHNhggPg24SMPOy6WNrP62ICMdSjDAtbgR4cxgy0uX36ghsKoS8cPNfpFAeuXR4QxZ8I70gvmqpDg_JKMViOLtg0WBaXqYQxF-lqeM6q-2rAwB5rgxoPfBG88P8hodVGQ6JDtgId7TYscwZmJyS9dYAlos0SLdvHW7WNIQG8BgU2diATz2y8Ek-8Rl8uDGA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1602
[ {
"id" : "4d465c84-4978-4495-8b3d-a9dd2bdc4563",
"identityId" : "d6cc68db-3b98-48af-b6c5-76136c31639b",
"domainId" : "bc529602-96c2-4880-b398-e7f8e1b1aebc",
"createdBy" : "9542b578-effe-4852-8215-da772c694fba",
"createdAt" : "2025-05-28T19:15:59.114420Z",
"updatedAt" : "2025-05-28T19:15:59.145196Z",
"deletedAt" : "2025-05-28T19:15:59.144572Z",
"deletedBy" : "bcc07cc0-294c-4a6e-aa14-3b36d8bfc058",
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain 68 to identity d6cc68db-3b98-48af-b6c5-76136c31639b"
}, {
"id" : "2fd30e05-1019-45aa-bb2c-d50222fad043",
"identityId" : "e3dc4aa3-6b33-4293-8007-d61426dee7c8",
"domainId" : "471cf0de-9430-4a17-9a0f-aabfd18a463c",
"createdBy" : "b2c03dc6-7add-47bf-b319-dc1620999592",
"createdAt" : "2025-05-28T19:15:38.700267Z",
"updatedAt" : "2025-05-28T19:15:38.700267Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity e3dc4aa3-6b33-4293-8007-d61426dee7c8"
}, {
"id" : "f79920dc-1062-4860-b32c-72c96c35395d",
"identityId" : "6fb93691-5cbd-4127-90f6-01fe19752702",
"domainId" : null,
"createdBy" : "50301762-edcd-46b7-923b-756b0b575113",
"createdAt" : "2025-05-28T19:15:54.846212Z",
"updatedAt" : "2025-05-28T19:15:54.846212Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 6fb93691-5cbd-4127-90f6-01fe19752702"
} ]
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/2fd30e05-1019-45aa-bb2c-d50222fad043' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJ3ZExwcFNpWGFETjhlUmpoVXdMVEh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI4ODdmMDUzLTlmYzQtNGNiMy1hZWFkLTQzNWIzMmJkZWJhYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OSwiZXhwIjoxNzQ4NDYzMzU5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTA4ZWFmOTgtNDUyNS00NDljLTg1NTAtMDlhYzY1M2I0N2VmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IAPBa8uf4lnLMz2ehOWX_1jIx-zUAHu6uw6Zp_yQSMkrtufqhhjleQgM-7hXpcvsuDOnlme8RcO5unB35L3m4Ae9xNcdxFSNftnxQ4HspjVfUh0koLTFS5F4fy-NzxBROouU788FdiNm7lCy386ysp9yoMggBIuoZv2T_1NwatcACSX7686btPeA5pvMdvwO30uoPrG0OdCKmambDeTIwYZS3BTSNcl6k6cBH7wAYTiBvqJXiz_lWZLLXAywvMl1IF7cxDXnJ3HZg7i-pYXQKn2Kq6Qlv3obZpAsdbZlSfs11-fzU8lpRo2NcQO98PAnNcJK-6YFg_GDlOj6jBLm2g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "2fd30e05-1019-45aa-bb2c-d50222fad043",
"identityId" : "e3dc4aa3-6b33-4293-8007-d61426dee7c8",
"domainId" : "471cf0de-9430-4a17-9a0f-aabfd18a463c",
"createdBy" : "b2c03dc6-7add-47bf-b319-dc1620999592",
"createdAt" : "2025-05-28T19:15:38.700267Z",
"updatedAt" : "2025-05-28T19:15:38.700267Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity e3dc4aa3-6b33-4293-8007-d61426dee7c8"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJ0amszeXlXNGVqbkdLN2NfZVkzSzRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJmNmNlYjkxLTg5ZTQtNDg0Ny1hNmFhLTliOTNjYmZjZWU3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OCwiZXhwIjoxNzQ4NDYzMzU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGE3MTAxOGYtOTQ2NS00Yzk1LTk0M2MtOTE1Y2FiYWNhZjYyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fSx7XCJpZFwiOlwiMzk5NTViODAtY2I1NC00NTM1LTk4ZWEtZDE5NDUyNTk3MGY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.iwaRut91xTPmuqEH5RmKLIEOSAuq-C8pzyHN-ktWzLt93poj__5-ng0TJK_8S_NpkSIMtJfraq8w6f_UvG8g84HwWk0rhlppoL23E1UCUXzsBSUZuUk48EGeIiIFPf7F7NKUkeAohuzVz2q7h-Xwpf7QToi9Ub_36y5QshjSv3gEhbzQatJUpG7hqXHeX8jytzcKo2wC65ooon3bLx2ceXfS8aurHwkp8pnBWR0_pO8eStKiltkswxNwBAzE1-7iAfoTi5TC1e9ug9-9UY7TW3IUBjnUqApok578Ug4T3RwB_fxgxXUlRz1Gh8CC0fQ-dLH58Nq85YOo-SDWSkob2g' \
-d '{"identityId":"e3dc4aa3-6b33-4293-8007-d61426dee7c8","domainId":null}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 488
{
"id" : "a6a01eba-3cd9-493f-9869-ea3df48e91df",
"identityId" : "e3dc4aa3-6b33-4293-8007-d61426dee7c8",
"domainId" : null,
"createdBy" : "bf6ceb91-89e4-4847-a6aa-9b93cbfcee73",
"createdAt" : "2025-05-28T19:15:58.932148Z",
"updatedAt" : "2025-05-28T19:15:58.932148Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity e3dc4aa3-6b33-4293-8007-d61426dee7c8"
}
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/4d465c84-4978-4495-8b3d-a9dd2bdc4563' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJNWFp2SlBKTlE1UG11MUIydkxmd3N3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJjYzA3Y2MwLTI5NGMtNGE2ZS1hYTE0LTNiMzZkOGJmYzA1OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OSwiZXhwIjoxNzQ4NDYzMzU5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzlmMjVhMTMtNDVlMi00ZDNkLWFhODEtZmIyOWI0NWZjYWJkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.v-kxHVUALXR_P1MNwpyKy6Y4wGtwSgxWiglgAXRw4tCWalN0RQ7zgdalbnokxF48Ty32LbVtdwPfvjNtLe0E-okzWSkB01DK9upHB90rlMSytESIveld3xzG2D2cS6zynbLf4tI_ajO_Hj-rAR7cFb9hJCGi_8hEufOA54gu5fnmW8sk7NndQFh-GK7kQwD0aMwP42PzAhfN6V22VCYxe6IOEcNY5e4rt0xEztGF7MPdyKoUWg4f-0EhYlLZs0KK9zixbWjEaq5Iq0qsKGrw8k4xnYIBPILF8IZxIWyPXqVVMrpJEwoTXPUiEWhOcn4f2LUgdt3KmWmbXscujwERcw'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiI5ZUhKeW8xTWR1SHRYMFdfSGlEVmR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU2ZmRkN2FlLTViOWMtNDkzZC05ODU5LTMyZjkyYjYyMWM1MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NiwiZXhwIjoxNzQ4NDYzMzU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTY3M2M2YmMtZDJjZC00MzFmLWI0MGYtNGU1ZmIxYjczYzVlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.JwMhnFk1f4InUQbKid3Augx8z5GEVnvwNZ746QMREg2_cPjhNlv-sAnPx1XwQ5oEWeP7rc-FlRu-AQx8pO3m5mzA9ToswlTXFl6bOqmWmtLfrK6CeIRd12_3CMyPOTM0rMTs1elO04f84QvbKQXxZLsG80b0AL42LCtkBXY3dIGGX5GyHcUInreJn30cTqxDtpeF-3y8u-IP86GBmz6WN7AJNy93hKUZM2hCSZnidNdXqF0NKvHBagEsjkixpbjnkFacWEAo6Cbqs-l-a1QaZAFjFtuopLJfF8ZNvdG7K4TEiOLPtYID20s5UlaFEaCjnbGaJtPnbVI2_dCV5uZybg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1472
[ {
"id" : "a2177edb-5709-40e4-bebc-edac44cbd54e",
"resourceActionId" : "e1230e57-e1b9-439c-8c15-6ccdf89811b9",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:22.936156Z",
"updatedAt" : "2025-05-28T19:15:22.936156Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Read Resource Type, All to All Authenticated Clients"
}, {
"id" : "5865b46b-ef90-42ac-a025-d94f302c2bfc",
"resourceActionId" : "39a40463-9f7f-4272-8860-a9e3b3686693",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:22.552328Z",
"updatedAt" : "2025-05-28T19:15:22.552328Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Read Data Center, All to All Authenticated Clients"
}, {
"id" : "3c95663c-88fd-4a75-a59d-6bd19f492da0",
"resourceActionId" : "4661bf1d-d967-4360-b34f-9e0d74442f70",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:23.655793Z",
"updatedAt" : "2025-05-28T19:15:23.655793Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Read Workflow Status, All to All Authenticated Clients"
} ]
Get Public Grant
GET /public-grants/{id}
Authorization
This endpoint requires read
action on the public-grant
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
anonymous |
Boolean |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/571069d5-b5e0-4d0f-ba67-95a4f6b94505' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJhVWtjMXctUS1PSm9jSjNMTlNBUWV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFlNTQ4NWU3LWQ5MmItNDUyZi1hNDk3LTRhMWE4OWU0YTFmZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NSwiZXhwIjoxNzQ4NDYzMzU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmFmM2UyZjUtZDkyMi00OTJlLWJhYWQtMjc5ODliOWNlNGQxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.rn1aEuLGqxzYBG0vKBao2FdGW7HpZE9wcEo52zMzlvd_ORll0PB1OWhiZ_fUk9GRcz-8ymuuc9ZOgjOxfxgnRFkrs7cC79lyMG83tgplxj85FbMwkho_HOolKOaEsU0lHjcOFuq8zuvrNP3N_I1zJTfSX11bycKJYJL8fffaaewC7a-ElnkNAaPnJ2bAHegScfYWA_B1lZ1MK-9LUtipd9SRLQGqIV-opz5h4VfvJ9UhjMyO_AMrQC5-tEW3cospH-vH_jluSDZtAAj4eHK3HU-qh-wsKij6WIc5_OUHERLoKPLAFcpHdilee606uLaQZoltCkZta2n4sltwFinRdA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 678
{
"id" : "571069d5-b5e0-4d0f-ba67-95a4f6b94505",
"resourceActionId" : "1ca28945-a329-4e1e-b747-baa2748eb9f3",
"createdBy" : "f1310ad5-f759-478a-999f-1086184ed445",
"createdAt" : "2025-05-28T19:15:55.943262Z",
"updatedAt" : "2025-05-28T19:15:55.943262Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "04822f3c-2b70-4a1d-85a6-c81f6dfe0fa4",
"resourceTypeId" : "ac5b8ffa-3e46-4532-a32b-3c2100912830"
} ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Test Action 46 Test Type 45 on/under Test Type 45 04822f3c-2b70-4a1d-85a6-c81f6dfe0fa4 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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJwZlJ1WWtCSlRKbmVuZjdmajh6R3hRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU2NDM2ZDExLTRlYmEtNGUyMC1hN2E2LTg5NzNhYmVjMmMwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NiwiZXhwIjoxNzQ4NDYzMzU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZmM4YTg3MGItMjBhMS00NTAxLWFiMWQtZGYzZGEwZWY3MmZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fSx7XCJpZFwiOlwiMGJmZWZkM2YtN2Y1OC00YTVjLTgzNTctYTE4NjMyOWM5YTllXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.BxpVNNEN-ej79Y_Rk5iJ-GwLw_4DzmxGYKlGN6uI4czUyqoQT6u1Am2b3GXqflwZINOJz7w-N6wAS47r5oja9KV1bUgl6COKUpXBVcP7lEYSPs-x01VLhcFF71Vnnj1w5QidqHE5FzH-YWJtrdgy_w88XQFSMkeAuOuRBxBaAdez03nk31aj6BnZ__6C5uV4nc_5PwZOoj9Ci2TM3K_mCdl03mQpWDbqYUlahELr4OVfcIe1SmuzHLfYoo0cBY-Alv76PHj8Y43yS1GQSUlfRCfvuIAMFKerJOg2_G8_ArQKdFcStoCyjyEvXarSmzbkcFNnfC3a5RN_ZnGnYrf0kQ' \
-d '{"resourceActionId":"5f1a0c64-b5e9-406f-b288-99fb4201dc93","path":[{"resourceId":"3737a01d-e6dc-4e17-95f7-114db77c4382","resourceTypeId":"62818b11-0630-4581-b542-6db692e2a258"}],"anonymous":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669
{
"id" : "d75b98a1-e615-4410-8b63-b0697d8fb33c",
"resourceActionId" : "5f1a0c64-b5e9-406f-b288-99fb4201dc93",
"createdBy" : "56436d11-4eba-4e20-a7a6-8973abec2c0d",
"createdAt" : "2025-05-28T19:15:56.229229Z",
"updatedAt" : "2025-05-28T19:15:56.229229Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "3737a01d-e6dc-4e17-95f7-114db77c4382",
"resourceTypeId" : "62818b11-0630-4581-b542-6db692e2a258"
} ],
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"anonymous" : false,
"_title" : "Grant Test Action Test Type on/under Test Type 3737a01d-e6dc-4e17-95f7-114db77c4382 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/6e12803c-109e-4ebd-8833-de5ecb1e58ea' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJzQmRVVEVTR21lZlNPT2wydTNZakZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY1NzUwMjhhLTJjNjUtNDdmNS05ZTYwLThiMzExNDdmNzY2NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NiwiZXhwIjoxNzQ4NDYzMzU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjZlMTI4MDNjLTEwOWUtNGViZC04ODMzLWRlNWVjYjFlNThlYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjRhYjRjZGUtZDRiMy00MzI3LTkyMjUtMjc3ZjkyNDFkZjIxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IieGLDn6zU6D6A9KK1LzSma6DI7q96rTn051Y7_FpZ8JT4C_KcXh9o7_QPpf554H9DoXC8JUOxUbXI6YyvnIyzC9b2ZJn7I0sBpml2CIcInKKnwE-3MIDBk1uiOTZCpu7QED3nbufm-56efg2sUsQQqIUfw3NlhJch281BhKaEliGF414Dms0WX9YuB043aICbP291TdJK5tJFqwc0DgA5Blfq_CwfaYovd5libNXjzOIBCKR8AGnXgh36FHoB8jmGvc4OvrkUSCpAapAWqkasxWlVU0hZEnRo-cW5bKu0kucD7IAAxT-v4jFavppnpR_gP-lOB1r9X48l5EEV239g'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJRYlYyNHhPWFFJUXRCb1FkdTdCdmF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVmMDAwM2I5LTYzZDYtNDllMi1hNTI3LWY0NmVmYzdmN2YyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NSwiZXhwIjoxNzQ4NDYzMzU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjkwZjU5N2EtNDA2OC00NWYyLWIzOTAtZmIzMTE2MzZhZWQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.MSXuhDJZZynViCV-pubmhzwEr3X0IAKG3kdUZ6z7RZ_Y_bPooXwrm6uBiwldpJeLi70a1RUPzfYyZCPVQQE4UkYf1Euf4TNwApVr-YAsPEh1deid1_LynzXZJTo-_ig5Pc98251PNDEhPMgPgT7Cy_V6rL6Zbw1HvmrRejZYd8QvqxpUl-03YCjQFHDSTNWPQl57T5gsHJ-XtBuSfWOCa5SQqlm8AtKGTdx7n9HfbxU8RcRCBYTL6XZCItJQqDrWLvRJscqGjbKQ--qmfm-uplfF_CQnBtOeYelZUAbXMTjARUR1sc2MZAdnnafOpVi44xUpUTIxVe3fJdJS-iAHWA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1719
[ {
"id" : "9f8c8f9e-3a4c-4ff3-b94a-75a373abd92d",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"resourceActionId" : "fd104d41-becc-4b38-a7fc-5cd8ca33dcd9",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:22.811685Z",
"updatedAt" : "2025-05-28T19:15:22.811685Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read API Account Identity, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
}, {
"id" : "80f379e8-b967-4f4a-974f-f9e1ace303e8",
"identityId" : "48ef8928-4f59-4428-b4df-83cd7ec770bf",
"resourceActionId" : "eb94a387-4a94-4e57-840a-1fb4253af8f0",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:25.116626Z",
"updatedAt" : "2025-05-28T19:15:25.116626Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read Self-Service Subscription, All to identity 48ef8928-4f59-4428-b4df-83cd7ec770bf"
}, {
"id" : "329c1959-70e6-4532-aacf-d312e3898502",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"resourceActionId" : "e04c01b5-2e2b-48a9-ad53-ee52ed09a4b2",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.416261Z",
"updatedAt" : "2025-05-28T19:15:26.416261Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read OIDC Audience, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
} ]
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/afac1d68-aafa-4616-94ce-c2aec0fb8bff' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJEcVZTMG00SjhmTE9DTmFhS3FZcldRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIxOTAwM2Q0LTQ1NTEtNGU1Yy04YjA2LTMxZWRkM2FiZWM4MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NSwiZXhwIjoxNzQ4NDYzMzU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTdiMDQ0N2ItZDhhNi00MDhlLTliOGMtZmIwMjM2ZTNhYmM1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.hvfgE6QxkgkKS913yzVJ5X5bQnHqyLpnaHS_kpDuxpYC7ji_928Y2FRO4Aw1ot7EDQGHRJviQgTruRzpobkqWHWgLW-qPi1Q1xxDVS8XMec8R0PLqdhzJUJtWNNOl0E04rtut51IDV-AOCsZnTlRhXoJvHDLkCwt-qXK-G26DpLEdEX7lcAfBapj-r2jccw9dAwOknkZjzdLPVxi9kYrE2SfHkfXl4qbHgmrzjrR_MFwjIsc59A-_AltsWW4ohESLJL42IJl0aNjh6mt0eVZdnCeVqnSJcDzCijlGfDZqEK0AyNSn6v71Tm-TTgoNUloH2ypx3VbXFgYuoPgqrYoDQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 754
{
"id" : "afac1d68-aafa-4616-94ce-c2aec0fb8bff",
"identityId" : "d5694aae-c21f-403f-8879-be76d9b1a664",
"resourceActionId" : "b88f8524-ed53-4be7-a6ae-a4862f1f0b1d",
"createdBy" : "4e09c2a4-0d31-4085-979a-b381b70c0b36",
"createdAt" : "2025-05-28T19:15:55.702596Z",
"updatedAt" : "2025-05-28T19:15:55.702596Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "7e4ff533-32aa-46b3-af3b-97803c905de6",
"resourceTypeId" : "f25120f2-d406-4c03-865f-7c9a4f1b9e5f"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action 43 Test Type 42 on/under Test Type 42 7e4ff533-32aa-46b3-af3b-97803c905de6 to identity d5694aae-c21f-403f-8879-be76d9b1a664"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJNT1Q2dG1RaHJjcWhSWG13NU5XTHZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQzNzQwYjMyLWI3MmUtNGNkNS05YTU5LTg3NTFmZjI0MzMzMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NSwiZXhwIjoxNzQ4NDYzMzU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTkyMDdhNzEtZjFiOS00ZWZlLWE0MzUtOTkzMWRjNTIyNjZmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU1fSx7XCJpZFwiOlwiOWJmMTRhMTEtODE4Ny00OWFhLWIzNGQtNjNjY2M2MjIxZTk1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.uhdMbPAROygbBgBYtjE8OQvxAL4gfelBHJZhgTegMl5czETWbdA60FFiZ-3Gz0QnvUBSg4QtypfLX2egxp3y9QERI7dU7fOEhuNgmpULoOof7JbB1ogJdDIrg_NcBcklwEHalFXuwmr2-R5f_0_3zfapoVFZo30h36PEoC8ylljBPprj96AMED6gjZMGNfpop8bDWdKIQX6UjIaIEV05xC1lPVtu-P3MbED2U3u5rls0clBQVpjA7gBEiUadPN0j8jzZQwN6o1TBe8mMH7FIUke-CBnwXb41XVEQf96eNh19n06AXg2iFKnGRLNab-c19ypxF8dMnOSbjfQnEOkm0w' \
-d '{"identityId":"137292dd-8d78-4a9a-a795-42b2456b1033","resourceActionId":"5f1a0c64-b5e9-406f-b288-99fb4201dc93","path":[{"resourceId":"c5d9123a-2be8-45b4-83a6-3f37aaa6a829","resourceTypeId":"62818b11-0630-4581-b542-6db692e2a258"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 745
{
"id" : "1ea7de68-b488-49f4-bf13-d70400862591",
"identityId" : "137292dd-8d78-4a9a-a795-42b2456b1033",
"resourceActionId" : "5f1a0c64-b5e9-406f-b288-99fb4201dc93",
"createdBy" : "43740b32-b72e-4cd5-9a59-8751ff243331",
"createdAt" : "2025-05-28T19:15:55.845500Z",
"updatedAt" : "2025-05-28T19:15:55.845500Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "c5d9123a-2be8-45b4-83a6-3f37aaa6a829",
"resourceTypeId" : "62818b11-0630-4581-b542-6db692e2a258"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action Test Type on/under Test Type c5d9123a-2be8-45b4-83a6-3f37aaa6a829 to identity 137292dd-8d78-4a9a-a795-42b2456b1033"
}
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/712351d8-a94a-4b06-a36c-6a02595e4c0e' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJyUXBmcGZ2RzhIQkhNWXQ4M25oN0R3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBlNzgyMDRkLWFmMTktNGNiMS05ZjM4LWUxZGU5ODQ2Zjc3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NSwiZXhwIjoxNzQ4NDYzMzU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWQxZDVlNTUtMWI3NS00MDQ3LThjNzQtMzA1ODdjMjMxMmUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.JJEmzxZEdnU5N2ihWwT5i1tXLPH0PuO7j1YvskXz3A4EhQwgnriq1KjinRLxyn2k3AjcKffkooluZMzgeOubEB5y63ZfXilnpJIw_8QTbBkUQlGVws32X9sQZvOWoWWoaMrtq4j3GMFEFT-ZLuk2YIhr9RKSDPvX2Z-9JFAvU4hnlXKlu5enKVp3xhohR320kZgQzglVJwYjW5TXHI2wmZxPjq4R27ODNKd_ZCMy-L3TKBZmpnk7UczW5qAY64xhfWybVFUc90huM0EfLw6uTZBDn-KKjdoO5ONiXtajl15HECTmzGB955nPADgRWm6EuPmhMOtNIDTFcjEmWnIBZw'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJfel84TWlsRC1KNHNWam10emtYVTJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhiNGM4YTFlLTQwYjEtNGJkYS04OGUxLTM5OGY2YWYyNGFhZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MiwiZXhwIjoxNzQ4NDYzMzUyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTU3ZWQ3Y2MtNjQzNC00MTBjLTg2MWEtYzBlNDczMDA3MzQ1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jbJsx_LSVZQFyYiaU9BwPicNzaYdXfWIsOYCQzxGaiSTOUgsEAY1qpia2njHIAazhiH6kVEjOi0FpeNVxiS6E_iOM64B_2goCvfvHIi1oPoVMrPQBGnG7lHfO0Y8t1jbQxBPiLb6pT9jAPc8Bctc1sVYsRR2rUx8KcNxfxRVrTwritjN92J1MLhvDAS0u-THey4g-K2kmTaWn_DQ2UMvcD6YrhfERGiaWD9wM3nExd4ZAbfAgEfbwm2jRVfCbyCrUg3tGUhiW2D5UKP4yOVZ0tS-6yxevc-pdfw5BRLYrQO7Wb3oGbyGb2I0YKvQKPluqUS8iN5pIHCV1ukEgx8WqA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1169
[ {
"id" : "4746d315-81c9-4bd7-91dc-42660bc48a92",
"name" : "Test Custom Role 23",
"createdBy" : "529c2035-c976-423c-8ec4-314588f8a115",
"createdAt" : "2025-05-28T19:15:52.198902Z",
"updatedAt" : "2025-05-28T19:15:52.198902Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Test Custom Role 23"
}, {
"id" : "e76a2e70-2939-4fa9-9f59-dacdcb0052d1",
"name" : "Test Custom Role 31",
"createdBy" : "813b10d5-541f-4eda-9133-d73abd2f55f4",
"createdAt" : "2025-05-28T19:15:52.723695Z",
"updatedAt" : "2025-05-28T19:15:52.723695Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Test Custom Role 31"
}, {
"id" : "668720a0-531a-44fc-b196-4d3dbfba73eb",
"name" : "NF Billing Admin (ALL Accounts)",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:24.916097Z",
"updatedAt" : "2025-05-28T19:15:24.916097Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "NF Billing Admin (ALL Accounts)"
} ]
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/e76a2e70-2939-4fa9-9f59-dacdcb0052d1' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJMWXpYQm1GdkJPd3JMZUZxSzNWYm9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZhYjA5ZmZlLTQ1ZWMtNGQ0MS05ZThjLTUxNWNhOTQwYTFlOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MiwiZXhwIjoxNzQ4NDYzMzUyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZmE0ZWE5YjQtZTg2ZS00MjhkLWI4M2ItYjVmZmJkODFiNGRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fVnmEIB6Km-qBLl4g55ROHn83NJYWtQJd2-Vh-KP3wblMK7-59ha6xUtW2Yao2lnzVc6dyrT93zu_vmtKwE8DCvCIs8lQL1T5HlNa-svhwchztTT294VV_K1hSs83pKRrWCq68OUZDYyIQYyJnXmn_7Hyy2Vf_Cyr11pVdGZ4CAZI2V978-nv2g_WTPMg3MAMbx0N0su0yB0my5Bm-PUZcEhD557NTfCupGvIgpHIPCx87qRsjGhwOhUe2zAEx1gvET3pnPZ6JA2-nJoeEtwYZ-2-A7bynLvNzXYg1iZUI5qcJudrq-A3U-LRfxNsQavh-bSDkgAMsGYoFbnAqyOqg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 379
{
"id" : "e76a2e70-2939-4fa9-9f59-dacdcb0052d1",
"name" : "Test Custom Role 31",
"createdBy" : "813b10d5-541f-4eda-9133-d73abd2f55f4",
"createdAt" : "2025-05-28T19:15:52.723695Z",
"updatedAt" : "2025-05-28T19:15:52.723695Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJWYTFSZGtuOW9CZHNXOVZfd0pNY0xRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNhZGQ0ZjhiLTM2MzAtNDg0NS1hNGYxLTRmZjBmYzRjZmYwNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MywiZXhwIjoxNzQ4NDYzMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDI3NzA0NjUtYzNiNC00ZmE3LTk4MDgtMmMwYWYyNDUxZTg1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.i-iOrV6xzzy9Hls7xOu44K3PPK5Ft5HvRPl8hPRF0xArxYEeyb7FprkDxE-IJjzaqqTnLRBZWtzmy7qKDPn2XLIx8z2HRliZXUhb5TKx51fVXj_RsiQ2jLLpxzZwtkbMYyjdM9AeJNvehwAOiPnDeY3Tpu5SXUmyqERfK3n41pwhQSLJlAog8wYys8kiP8e6pgnrh951XufJXC2r6urrA5ifAvpGKEweSstViUXNWYBHGE7igUZFCKM0b2mZJZ_V8nR44qMRgqtoX9-pTfdonGpB_Z_ggMrUrRFqzzGoFB-5AtCI-3Y5Qa0KUtaZgLwimnImuIwQHJttJ8pHuToivg' \
-d '{"name":"Test Custom Role Create"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 387
{
"id" : "63f8f586-ad79-49ea-9e90-199069726fb6",
"name" : "Test Custom Role Create",
"createdBy" : "3add4f8b-3630-4845-a4f1-4ff0fc4cff06",
"createdAt" : "2025-05-28T19:15:53.368777Z",
"updatedAt" : "2025-05-28T19:15:53.368777Z",
"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/7435d383-08e4-4add-ac47-adefe782e683' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJRUXlUbWY0YUtXTTg3MmJQek52NHdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg2YWFiZDFlLTM5ZjctNDZhNC1hODI4LWEwMzFmZTMzY2M3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MywiZXhwIjoxNzQ4NDYzMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWI5NDllNTQtMjdmNy00Njg4LWIzZGMtODM0MTRjNzg0MjY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.m-leRFNgPaKGitsonqE4FmVR8GQP9Mw-UipqhqCBTtUx-Qd-GsOF6S65vuarutI-pGMPeBbRlRmMdNXcAGVZF0em2ktR8N1xjTITfbf_E7HoaaKw8PZw6HoCrXSpvYCZ3VL_bBIKUci4WeCSWEh0EFUzhd7fLD2hvFNGJLinP04ZFR6BsadrEiYKryMHOcn3upa21vquGHOlMxE-NhlOpWWih0ah24h68SkKfUfNKlR4Qnrub86Mw7j17KXRNDYK2D50mnwzA4eHEeLSVzqff4EjQJjnJnSUEH1l0mhnw_19Sqgn69JOeyC6rkwvJpu56KL7FGo5sL8BFHBDaLUgjA'
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/c9882e1b-c2f7-4df5-a3f4-b510814ffa63/identity-grants/c51a0c20-10c2-4b6c-906f-fcac99119460' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJZbFZBTlU0NDRYdHFRQzB4cFJTNjBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBmYWI1YzI4LTAwMDUtNDM5OC04MWE2LTdlYjk5OTZlZGJjZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MywiZXhwIjoxNzQ4NDYzMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTc0YzdhMTUtZmIyYy00MjJkLWFkNWMtOTdlY2VhOGIxNTY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfSx7XCJpZFwiOlwiZTYyM2IzYzUtYWZjOS00ZmM0LTg4YzctYmMzMjEwMmVlODkzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.wAZ9waFhmdgNFJnuKZUOcJx85hd492lqjacvFbr9I3ruBC_lrfk9AQE7cpAYJcPMvw9ZLeRh54WtDQ3f6CzhjkePT0KUp3OtYsTpU65JTvf_o6--pvJc7EVQVyJG1upLyfkXdLncT_fGOs1X_tzWfX2isWGjzw1L4F2vr2s6P_SnEkI5eTX-Up9mD3ltyPxnxBFF_oUf7eSo68V8Axpm8ASovXvwnZCDnek1hQq5wYW28pbnw2t1RSXf1RslrqEud6XtuE_39IfVZbP76W5k2sfX3XPbBYov-BgIgLiKWd-m30OssLXBW5llZ3eDqYFD6bQ-oS8FaGq90nq5xPOCZA'
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/11aff8cb-fb4c-4e31-9885-2597db9abbe7/identity-grants/9ba7ecd8-72ef-47dd-af0e-3011936238fb' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJnVVFkb1FoYVE4QlNsa3JKRTNlNVdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMwN2NjZjhjLTA5NjItNGRiMy1hNjFkLTM3MTBmNzMyZmMwNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MywiZXhwIjoxNzQ4NDYzMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGM2YTRkZTgtYTBiYS00ZjM0LTkzNTctYzQxY2I2NjI4ZDMyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfSx7XCJpZFwiOlwiYmUzOTc0NDgtYjVlYy00MmU1LWFmYTAtMThkMjU2MDMzZmY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DCZiF0xJFsoFUtCGiYRAGfBFvV9-DncikwN1cEsHC0MwINQ_X6t2HnHjEz_ZZs2BNhMOl9ZgaiJtdVTjVsZF7BFUk-ehAak3lM_yVEDMJEQ1hv7yHKu5AgrAvoHRjZcJm3jmCCkgtSUXcL6OOyeZeH85FZjJ2UTUJTb6buFml5LVlVn0Fmr_0Sx_xmZ40EqyYrSt_9e_s7U24U8-FIRzKP2FI1Y8z2yhZTt9Cpx3lafokeZtsRPjeanVm1VsKxlep5VdTFKbfFWBUxGBUDZa2recyXau9iVRA9hD9q6Swv_IOuHO0XUNFg-RlnqmZaXwzSb6-xlxFLfJaNVjQdJedw'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJhak9PYm1JQ0ttNEtyLTVBZ2pQVldBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc3YTQzNTE5LTNmNTItNDhjZC1iNDNmLTdhYTIxNjdlZjBjZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MiwiZXhwIjoxNzQ4NDYzMzUyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWU2ZDM1ZTUtYjVkNS00MmM1LWFjYWItOTJmZWY3ZGUwODk1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PFhcC-mCyVYektPwHAovyrTAJ5PXhUjXlKUqhfnpCFk6DN1365F9dU0IasgFEG2x1EtpwJLZQsXvx55nwUChoYKs_LgHGaexNjHnbPXdraRLdVGlWUY7hKs-gBIxLvQb6QCGY_uGs8Slqk25ujt3xuBlltn3izTKDzeh8oXD6xOy4vPSGYsOWcC9x0KNhZWnuSVCgVZNMQv_hIrjHKDoDvtBWoR0QUp_gsVogeisxmE1xv3tajsjot6ucZGOL9Eu1pTEnngmzjslsg0DKBDHlGLO5epH5fN_t76V2Kb5H7bsdaeSZGB2Iru2XkAL6X9r-vOUP0SpJ1aE7_EZlBl3RQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1288
[ {
"id" : "ebebbcd5-954e-4c24-abda-96fa28247dd2",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "f916b7f7-8faf-4881-8a59-ed829e17b332",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:25.940858Z",
"updatedAt" : "2025-05-28T19:15:25.940858Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Update Transfer Node Pool, All"
}, {
"id" : "57b5c077-f305-4090-80dc-22f57e40aedb",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "a55381ed-db73-416c-8fa6-d59883af112e",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:25.937717Z",
"updatedAt" : "2025-05-28T19:15:25.937717Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Network, All"
}, {
"id" : "26d6a6be-1335-458f-a00b-15e560f4d5f8",
"customRoleId" : "74a9a6c3-106c-40bc-acab-780c837ad8d0",
"resourceActionId" : "fb62ba4c-4616-4daf-8931-5af4d9dc7911",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:23.175528Z",
"updatedAt" : "2025-05-28T19:15:23.175528Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Exemption Configuration, All"
} ]
Get Custom Role Action
GET /custom-role-actions/{id}
Authorization
This endpoint requires read
action on the custom-role-action
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
customRoleId |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-actions/25df0172-910b-4517-b6c2-9a9f2e459c89' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiIydnBvbG9BX0UzQmd2U2QxX0tWNjhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNmMzMzODMyLThhY2QtNDFhZi1hYTlkLTVkODg4OTYyOTE3MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MiwiZXhwIjoxNzQ4NDYzMzUyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDA0ZTQ1ZGMtZDA3NS00MGY0LWEzNjMtODgwMzJlMDUyMTdhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Tg52UeQg3mKbkJQqDke9QA2tkBjnMaZhe5oOpRG_495I6c1jGp2ZTZmU3AQMzhRaYzS36hOMoaIhxf-gx71BOeumwCQcvG5Z76oHrE38KJvc-i5XssUmt2Jb1Gp3UVVPvpcSiIlUMChu5BR5QlfMaHm9T-Adt6TTInfklJV25fbdCHDia-m62O2z8KjwoRz_K3Z_um2Kxis_zAbH_-UyXXxEoHVr-HXIwrDSFWMSQHvnaZxH8IzAHYqH9dsByh6SZs320DDK_enlFb4fIFjWuLsIXrt7rWaBdwMp4Yb6Mv5ZhaN99CiaCfyNjoK6h9QvipRZ7OPgQsN8BXjju4IO-A'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 613
{
"id" : "25df0172-910b-4517-b6c2-9a9f2e459c89",
"customRoleId" : "4746d315-81c9-4bd7-91dc-42660bc48a92",
"resourceActionId" : "fe88135d-7a80-4ede-b47e-394989a315ec",
"createdBy" : "f8849017-2cb5-412d-a194-da7c30521ffc",
"createdAt" : "2025-05-28T19:15:52.256515Z",
"updatedAt" : "2025-05-28T19:15:52.256515Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "713baa4d-09de-405e-90e9-ea761d43dcfa",
"resourceTypeId" : "e69c9e55-9624-4b99-8e78-935433edf516"
} ],
"_title" : "Test Action 26 Test Type 25 on/under Test Type 25 713baa4d-09de-405e-90e9-ea761d43dcfa"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJsaVp3YnhiMDA0d28zelVoYW15SVZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjczNWQzMTExLTE4YWUtNDAwOC04N2YyLWI0YTBjZjVkYjJkNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MSwiZXhwIjoxNzQ4NDYzMzUxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODQyZWM2N2UtNmVlMy00NjdlLTgyYjUtMWQzOGM3MjYxMmQ0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUxfSx7XCJpZFwiOlwiYWQ2MGQ3M2ItZTZkNS00NzFhLTgwMWQtOGQ0YmRiMzc2OTg4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUxfSx7XCJpZFwiOlwiODVkYThiYmEtNjhkNi00ZDNhLTk1NzItYmRmZTczYWRkMjFiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.xIxV2vMfYAZfeo8RNfWDM_HKpu-EYeH88xjUGh_LnPkjj-odGlaeUDd_kfcATGIM2_Y40AFedq-t46lY7kGiJwPt5wBFiVfnk6PdCqTwK14JFT8VqmIa_ZDCBWcGRIW5gJ6aXu7dZk06AXSo_sZ4Hy-B_T0UIzb_U7qTaIhIIRgaCKU1smf6wY9LEQEKXE1x-JYhUVObq_SVMgDLEgkUWQYan04mTWp7e-WMfn-KFnISzLHNuqX9c3tRKKD9OYFlHPTwrXkN0yglmw4FMUS5TLXxklqTOOrHIZy97Ra98kd4Goamy4lHuDdHGEcBBjuoF4Cjv0ZQVtn5hyTDLkKwrw' \
-d '{"customRoleId":"fd93125e-b292-4c8a-87fa-1c4e267199df","resourceActionId":"5f1a0c64-b5e9-406f-b288-99fb4201dc93","path":[{"resourceId":"1990b9ee-3a4c-4b58-971c-76ef435f32e9","resourceTypeId":"62818b11-0630-4581-b542-6db692e2a258"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 604
{
"id" : "e03f7de0-6268-4927-8e3f-5c3697b9823b",
"customRoleId" : "fd93125e-b292-4c8a-87fa-1c4e267199df",
"resourceActionId" : "5f1a0c64-b5e9-406f-b288-99fb4201dc93",
"createdBy" : "735d3111-18ae-4008-87f2-b4a0cf5db2d4",
"createdAt" : "2025-05-28T19:15:52.013775Z",
"updatedAt" : "2025-05-28T19:15:52.013775Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "1990b9ee-3a4c-4b58-971c-76ef435f32e9",
"resourceTypeId" : "62818b11-0630-4581-b542-6db692e2a258"
} ],
"_title" : "Test Action Test Type on/under Test Type 1990b9ee-3a4c-4b58-971c-76ef435f32e9"
}
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/b8d6af6d-1dc9-4e44-b6f1-a035748e4ce6' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiI3SGR4RnB0X3NnaXBPZzhjSVZMOHZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU5MzlkZTg2LWMwNTctNDIxNy05OTA5LWY0OTA0Y2RhNTg2YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MiwiZXhwIjoxNzQ4NDYzMzUyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDliODQ0ZmQtYjY3NC00MDE5LWE1ZjAtNWY5NmZiMDBlMmZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.xn0RXostB70mcW7ADuuEeXsiqPVBA-cb_PdVHITX-2i9WqQ7GM9FoSqyKWjmcgPelsr8vJ4PbcvQYahxlBEW0vvui9lGCNvpO1qqWigAXa9g99Ev2JW24Kix7iZl_SGq4LULuvfXgtaDVl5Jucp53hi6ZD-qx1f8wkuUCbpj59jUpB91Cq417kdBEgJCX-8ErAlShQyRjt-HCoi3QfWGdl3Fhk0qTpgQO7MirBQHydbPFzLGBsyOQuQA-NmZt78jFOonEC5cbDK1Uj_JXXOWjj9PHJLJuJDY-9IPZoT5Xo3bv3kj8XhpESFnM9UXPYQKgQD89A56jd9n1ReTF56_sQ'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJsRUlGQzNmQ1hUeHVtS3FOX3RiSDBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI3OWE2ZjkwLTdkODAtNGZjMi04ZTJmLTU0Yjc3NjgxZjk1MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MywiZXhwIjoxNzQ4NDYzMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTBhMzgyZGEtZDFjMi00MTVmLTgxNjgtZjA5NTg0ZTdiMGY3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Cb3XHDlJFyJe80CrEJk7siE_5veYE5K3-Mx0GQjGVKGqSRwyzEk31oNYS9NMzc1LeMsDSHBXD2OdyLuNATetIu98z5d5mNx_GUsW7js3dDlLJNrfLLG3ssxZKz75KsV6OQlIb5_2se31CP-MgQ9VcNJsV-xjGGXUS-FYpvzebkC992H1mt-DKL4X-e1vH_2jh1qrzn4zQuPqKJPFrcMXbpRYv8C4OH9Teg4EZFZ_GezQuRmqjqffeGRWe8qIbAZyIpGltORBhsviV9ssOuSPz2JvNkAuq-DBoC30f_JPicoea4yiLS-Z37zSyqaR_XO9lHAlxkwurgVrvRffNcGsfA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1415
[ {
"id" : "7de0c68b-9a1b-4688-8747-169ed7d9f15d",
"identityId" : "3fb91536-ba33-11eb-af69-0242ac150002",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:24.895934Z",
"updatedAt" : "2025-05-28T19:15:24.895934Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 3fb91536-ba33-11eb-af69-0242ac150002"
}, {
"id" : "c5c71d15-bf89-419c-a850-2f2d4a4efa54",
"identityId" : "5f854c49-b5fd-44a1-b14f-a9c4aa5a7eba",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.354670Z",
"updatedAt" : "2025-05-28T19:15:26.354670Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 5f854c49-b5fd-44a1-b14f-a9c4aa5a7eba"
}, {
"id" : "6f8683b6-9862-4466-8bdb-afb0c70002a7",
"identityId" : "d6390902-e5f7-4c03-93fc-8788bc6067ab",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.594758Z",
"updatedAt" : "2025-05-28T19:15:26.594758Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity d6390902-e5f7-4c03-93fc-8788bc6067ab"
} ]
Get Custom Role Grant
GET /custom-role-grants/{id}
Authorization
This endpoint requires read
action on the custom-role-grant
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
customRoleId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-grants/bde18da7-a4be-40e7-ba35-cf10a4e6ab50' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJGaGNRT1JiaGVOb0luc21INW5wS3Z3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFlNWVhZDgxLWI2MDktNGQyZC1iNTI5LTA0ODc4YzhjY2M0YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MywiZXhwIjoxNzQ4NDYzMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGM0Njg0MmQtMDQwNS00NzFkLTkwOGItYTBkYjYzN2NkNjI4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.mozE6-Jl3tstB7iZabJgy09Jw3AmOIMX1X2MIPT9VC5wfAaxFRNViX_6-p0bGsgkslg_FMP5wlm69Uf7Tv_TgDjHMMaEXQkaracyStjXdfIy2eTIbWOW8V6mZzMKXSaEmseXeQosz7HcQKPkrVi8Ps9RJ04UqHPIDuJxgQ0tvlqTGWgWdzpOE1Lc_JNiK0vHQXthqP5uFiQ504BMEegsuxT4b7L5lf6KjEllDHcEMbjwjm84IVzTnb2WMqo1Vvw_jOiyFofd6n4ZDCCSiYLO1fKv0eF-wheKMHQG8mydS9Nn-9UBCxjsOiSSZzg-Iv-x6xlqZlThu8HGJ0XhzpdP8w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "bde18da7-a4be-40e7-ba35-cf10a4e6ab50",
"identityId" : "cc849a95-32aa-422c-8628-54ce166404e6",
"customRoleId" : "dd741b9e-2787-4555-b3ea-44c5fca1e00d",
"createdBy" : "a506cbbf-b19f-48e8-9d04-dc278034874d",
"createdAt" : "2025-05-28T19:15:53.665668Z",
"updatedAt" : "2025-05-28T19:15:53.665668Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 35 to identity cc849a95-32aa-422c-8628-54ce166404e6"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiI5bnc3VWYzZVJ0cU04RWpKX2xiOHl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYyMDllMWY5LWRmYjEtNDRhOS1iNjY0LTMwMGI1N2RlZDRkZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MywiZXhwIjoxNzQ4NDYzMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTkzOWVmMmMtMTUwMy00OWRlLWE5YTgtNzA2N2Q4M2Y4N2YzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfSx7XCJpZFwiOlwiYjY0OGM2NmQtMzQ0Ny00M2VlLTg3OGMtMmNiMzg3N2Y4MTRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.lMkZii5y8hjbK_dUjOxBq4dGZ4JLi88tgoms6-xkcr7Ks6_XxmrrWq20HVEcs7Tk7xCxoNb7JtcuCoTuNfHrZWPOmGZFjNcCe5r-8AszLltxYBJUr3RhxDLAfzpQHMhX6bbPwG4Jt5SI1NJTzBCkhI5kjUUmCFVdRbnTrRUVjohi2R8uizVlnuZ_27iE5OlEQT-i50MALPwJ73NRXe39CxHOnC5m-cVYgEFQcPkXpfqY8dspQjGliXyEUKsdWH25h2kcI09vjQmHq58oC6lezrRCBdHJYWGXANE1wvrJpU_Q4BPwyVaKaCF6WQpGLWkY2CuYZsPXDRPfydwIdNBs8g' \
-d '{"customRoleId":"925be9e8-715b-4423-bd1e-23aafb389c4b","identityId":"3c846c5d-0828-46d0-93c4-1d988b90430f"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "0c47e744-fd21-4f42-b939-7bb45e7484ae",
"identityId" : "3c846c5d-0828-46d0-93c4-1d988b90430f",
"customRoleId" : "925be9e8-715b-4423-bd1e-23aafb389c4b",
"createdBy" : "6209e1f9-dfb1-44a9-b664-300b57ded4df",
"createdAt" : "2025-05-28T19:15:53.912320Z",
"updatedAt" : "2025-05-28T19:15:53.912320Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 37 to identity 3c846c5d-0828-46d0-93c4-1d988b90430f"
}
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/9d8cc599-bd02-4e38-bad2-d11ea0463d8c' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJyZWFNTW13YUFhNEVVa2NnSVpZOHpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNhM2ExN2RmLWZjNGMtNDhlMy1iMzkyLTRjMjk4ZTU0NmU5OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MywiZXhwIjoxNzQ4NDYzMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzk3ZTJlNzItM2YxOC00NWEyLTk3YTUtMmJhNTJhNWZhYzlkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fY7aAur6D1zpflzj8Es_vi9WEkKOfesP0zmEKjXXZV8AwHAJQ0GcF3td_4D-FK6Vpc8lT9iVM-_1DiD8Stg7NrlumEHpQaeSYQ0GXcPv4TYf-AwaAEyVxJpU88DKdWh4TzlRIJ6fqtjZ_StivdE5Eh1Of_coGN_WW-V21ErPhiH17dsnXHMa9ozVXM9v6Vl1BnDcxc7bL7A0iK7EQu6-uYEi7j2F8QU-nQuAu1KWYPvRZfkTcSsTUe8xJ0u5gJzNLFP2THWEZGGoYQBu0iiED-k8QweNDpaP_aFZMq0ovS0CpHc3EcNBL6hH6Nnb99KgSzAxNhLke8vo3EWbeA3qxA'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJOaHg5a0RzVlBNUHVDN1pkeDZkNk9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMxNmViNmJiLTY1YmYtNGEyMy1hNzk3LTRhYzEwYzZiNzJlYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NywiZXhwIjoxNzQ4NDYzMzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzQ4MTUyMTUtZTI3OC00YTY2LWEyZmMtYTUwMmY3NGQxNmIxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IHpyL1G3aKxhGpdM56YrXzAJLtcgz2z-nKNNg7AoSUz8S8WHoUbzd7oYwGeeikQMsKTmnsnGbXGq2lOhnTbvkDddaKlirPr50qYgPGOS_aqKVOdICs8SxVvXzoyOzlgsiPQWBoWD5UF-wkFCwwHj2KAf3Fkny_muN3Y7Pff6b7Uthn9X_yoQT0UckP-2xOonjlpPtswd02SRnVMret2NiY4BNgHzK7Yr5zi7JvOYpoP9DiHBugzh5vIHyZrNo2MAk8IDAFPiGj4O59iKQScOkU6qlKKE-5oVeYctY6Ntyj7rHi6Pk9NwuAhSvG2zuj6fyrm-wgp2PL8G1Gh9pRSuag'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1794
[ {
"id" : "b75be358-a3f9-40a5-972d-a804c4758041",
"standardRoleTypeId" : "9b3101e0-634f-4b24-8cd6-598317704db8",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.145295Z",
"updatedAt" : "2025-05-28T19:15:26.145295Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "bce07cd1-8f36-44a3-b279-26426e7a53ef",
"resourceTypeId" : "3cb2e71b-7945-4a5d-8ef4-8e6839a0199e"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Network Group Admin - bce07cd1-8f36-44a3-b279-26426e7a53ef"
}, {
"id" : "20873ae4-9b8c-4365-9c51-2a5f97169ddf",
"standardRoleTypeId" : "f591ce64-cedf-4384-a2a1-bd6b04a15b1a",
"createdBy" : "51fd0f40-6dc6-4259-a006-9a5b65e57e8a",
"createdAt" : "2025-05-28T19:15:57.401426Z",
"updatedAt" : "2025-05-28T19:15:57.401426Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "0d6addd3-7d27-4bdf-b1db-d83de7a63590",
"resourceTypeId" : "9f805f92-366b-4b18-9c5c-7248d29d2930"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 51 Admin - 0d6addd3-7d27-4bdf-b1db-d83de7a63590"
}, {
"id" : "e4f170b0-0d4a-4a41-a9dc-aed1f8e67c0e",
"standardRoleTypeId" : "ef8ed174-83c8-466b-8efa-53d09d309810",
"createdBy" : "536218b0-bc99-4639-9186-77d0f04a5a6f",
"createdAt" : "2025-05-28T19:15:57.603279Z",
"updatedAt" : "2025-05-28T19:15:57.603279Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "7e3beb3b-41af-4a29-b6c1-36e372311665",
"resourceTypeId" : "02366159-5b2e-4e2b-b254-c5ecd59e4a93"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 53 Admin - 7e3beb3b-41af-4a29-b6c1-36e372311665"
} ]
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/e4f170b0-0d4a-4a41-a9dc-aed1f8e67c0e' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiI4aWE2dXZZeE9icjNDMHNDTHR5N2NBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU1ODI3YmYzLTVmM2EtNGUzZC1hODhiLWUxY2JhMWRmMWFiMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NywiZXhwIjoxNzQ4NDYzMzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDlhMzcyZTctZjJjOS00Y2EzLWIxY2EtNGYwNGY1Mzc0NGMzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Rn0rgZsjruy4UAQHjeMiCv5qXEi2DQPv64H7nXz77lzhtrPiIWYKRKcVf0YLY_22HH5VSGf5Geyb6moJ6Zij7DyvMFzaC0YPbKXOdRBHb11p5JhNMIwLFHvmPRnatkZohmNVjZooZAwWvMeW8sHm-_cRpdv_r75IalG2AblISE2f85uZYMIQH7bpTOFAcFz6B7-TIR-U_ddhfYONZuzF3xezzxENTfcQ1yiEDdW8Gk6XdkRex7d8JUQ6DlWTMKFqAeUfG_XxQW33zCOcaYcqTEfDpfupE7pwfYlCqCBx4MTxWu8Z1f0L_M2Vuw6Gx2OYzluaTM0iT5IE1yl3c5ZhCA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "e4f170b0-0d4a-4a41-a9dc-aed1f8e67c0e",
"standardRoleTypeId" : "ef8ed174-83c8-466b-8efa-53d09d309810",
"createdBy" : "536218b0-bc99-4639-9186-77d0f04a5a6f",
"createdAt" : "2025-05-28T19:15:57.603279Z",
"updatedAt" : "2025-05-28T19:15:57.603279Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "7e3beb3b-41af-4a29-b6c1-36e372311665",
"resourceTypeId" : "02366159-5b2e-4e2b-b254-c5ecd59e4a93"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 53 Admin - 7e3beb3b-41af-4a29-b6c1-36e372311665"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJHQmQyd0VxVlBnb1hyZDd1RFhuanZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFiNDgxN2JjLWMxMTctNGI4OS1hNzY1LWM5ODFhNGM5YjhiMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NywiZXhwIjoxNzQ4NDYzMzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGVjZjQzMzUtMzY3NC00ODY3LWI0YzItMTcwZmU5NGQ0NTE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fSx7XCJpZFwiOlwiMzQxMmI4YWYtYTc5OS00ZjIxLTg0MmUtMDQ2MDM3MWU4ZTU1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.dTy3yKGX8idct3k33Ha7kAjP1Eu5oQbJjWy1d0NHqwdda3zsbhcO3KJUwdG9CA_j3TXaERajJnNEavfFMAm03VmxSck_ZjjL1ynaErzbmUbxoaN0n9K0OuCFB5aIG4d9G65AvbbS1tiq_leHQv4ikhmkfCNzUjSYA8YAMAB7HNMtaQM1GtB0ZtAjl3JFybpUKZ4m_rAXYN2YWzFy6l4lffz91Qb7avGtA_WS0HRGovS44RIhh9WFXquEofqsEGgvoPjvZdY78WMxfrco3891VUdn0fSWziUnjMj193gVVw0_ej0fc3dRP-MmuQndgQnpjFn5Q1TMK_cjueAfWl7vIA' \
-d '{"standardRoleTypeId":"b008b66b-a03b-42ae-9e21-3efae73e1400","path":[{"resourceId":"45ccaae4-d6f0-456a-a12c-d737a90224d7","resourceTypeId":"f1a0d654-6c85-42e9-a2a2-4f0d34a44a03"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "93c10913-4131-47d6-a942-1ff115e3b8eb",
"standardRoleTypeId" : "b008b66b-a03b-42ae-9e21-3efae73e1400",
"createdBy" : "ab4817bc-c117-4b89-a765-c981a4c9b8b0",
"createdAt" : "2025-05-28T19:15:57.756750Z",
"updatedAt" : "2025-05-28T19:15:57.756750Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "45ccaae4-d6f0-456a-a12c-d737a90224d7",
"resourceTypeId" : "f1a0d654-6c85-42e9-a2a2-4f0d34a44a03"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 55 Admin - 45ccaae4-d6f0-456a-a12c-d737a90224d7"
}
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/7edbc220-eaf3-4959-8d5d-14dfcf059d37' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJMdGN3eGxYU1loaS1ZYnBtbURfYTVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMwYzIwOWUxLTZmZTgtNDI1Yi1hM2Y3LTVlYmU2ODFmMWM1OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1NywiZXhwIjoxNzQ4NDYzMzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjJhOGVmYTQtYTdhOS00OGU5LTg2NDctMDE1M2JiMDI2MzNkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.RtaR6eXFRH-15e6a6sMcFN6hqp7vGkQJpoH0DuJIaprQnJQL76GN_Y-HeFZie6V09KPVHuuEF5rKxXQHTNB75o7yKXZd1XI0Sp2cBD6FcUROnP9I1gWWRne9As593nSRoENWC6rKBVlLagZyjWJewLxGRNxbcOPIfNW-MKLTDl9ulEtm0NkxsF8jl5yfNLtnL9JgXJC-dROkslrnAa6SMygAW1gLu792-zzyFwgF9ggv-8EctL7spGRGLS_sMSByyKp75xDR9xQ_Bpe0Ipn11lb-2RIFXl9a_QCH7sZuStUwLC2NsldEP5OieVjGuSE2fHGvR_QspnrNo9gYFL6NBw'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJTWHgyU1JoZm00WXhjV3JtclQtOXRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMzYzJmZjhhLTg0MGQtNDQ5MC1iNzdiLTQwN2RlMjhhZDIzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OCwiZXhwIjoxNzQ4NDYzMzU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjkyMzg2YTgtYzQ1My00YWU0LThhOTItYzRiZjlkY2ViZTVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.oCLbKRwEmThTwqP0DYwGP6sV9qvXXj8IrMf9bZmReK9g5Hz3-f0rOdaMu7quTrGtPsKlB8wgxaC5GbwCD8GV3SB-cWYeQYQUg-2Gn7hgeQ2KjvQa-p3O6izVreSFy88zlGNweljYzKXaSGhHcg6ilR2z4ZY97BCQ0-6n9mZ_n94_CgFGYnNnfUO3CQn_HmV0U1Sh3ASDG-DPTiaMtkMLetu75a2br_-HejOlXgSat9dIWRt8j3cRKi8kWHTwRakAZIFUFfazuhPYSfdcmOoFfULP_27nH6Zfb9mWqpIW0k8aaKSlQzxHPCOO1syj8bvrUoB0aFLwYZZuc6lzab5F9Q'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 990
[ {
"id" : "764433b6-9e25-45bb-a23a-d9e12ad88053",
"identityId" : "586d8ea7-6b3b-4884-bd66-8e2faae81f97",
"standardRoleId" : "20873ae4-9b8c-4365-9c51-2a5f97169ddf",
"createdBy" : "244dae8e-34a7-4ad2-a020-f66cec1a7a2a",
"createdAt" : "2025-05-28T19:15:57.447160Z",
"updatedAt" : "2025-05-28T19:15:57.447160Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 51 Admin - 0d6addd3-7d27-4bdf-b1db-d83de7a63590 to identity 586d8ea7-6b3b-4884-bd66-8e2faae81f97"
}, {
"id" : "57efb8e2-4f15-47e3-8a5f-e3a75482e590",
"identityId" : "91f9c617-ce3c-4828-82c4-e25d6867a9d4",
"standardRoleId" : "1e705604-16d1-4fb5-ac5e-d79a95bea21c",
"createdBy" : "4246c0f2-db98-46c1-bf80-fb97773d53df",
"createdAt" : "2025-05-28T19:15:58.189217Z",
"updatedAt" : "2025-05-28T19:15:58.189217Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 1b07ef52-b7f8-4f22-86e0-b764b0db830e to identity 91f9c617-ce3c-4828-82c4-e25d6867a9d4"
} ]
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/23be5640-effb-44e8-b087-12630def8248' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJsNHVCR3JsYTJfUDBvSkxZY29oVFZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI4ZjY5YzMwLWJkMWItNDExNC05NmEyLWU0NDI1OGNjNTFkNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OCwiZXhwIjoxNzQ4NDYzMzU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjE5NmFlNzAtNDI1Yy00NDFmLWE0ZmItMjY0MmZiZDY1MTUzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.sVI1h4tAfemUVQmaB9bDt1Wmu9dEsYaqrgiAxSrBbMChUf3x9huiwNpnOnEFJxW1C0dmLLgQMchwmv_TxPfqab5ZWTfn5K-X7lDQtQRNW3ywCxMQc7_8IMjct5P2qurPLBVwRvbfiS2Y23yst4FiOmUmAXwEnPLo4JEuLSLPcUOtMz97lQX9jJjB0Us__VS4reitgltasHPJj43EC-2LlSXDO0GPBW4PUeTFAIYujEO_MMD8YXEO2gAkkG8O_Lg75yDaCALq60ZCEMviGv7Q-oau5sRkPmnFXwm3blW4QL8dYy2nPAl-O92EL1LbFw9WQ2NYsRTCcAbfcuU3pdz4AA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "23be5640-effb-44e8-b087-12630def8248",
"identityId" : "de364b4e-2e72-48bd-8a48-dad1e8d7b0dc",
"standardRoleId" : "31aef240-4cc1-4277-a929-1d623bd477f2",
"createdBy" : "cb274ee6-72f3-41e5-9a66-dd42d957fc7b",
"createdAt" : "2025-05-28T19:15:58.356597Z",
"updatedAt" : "2025-05-28T19:15:58.356597Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 63 Admin - c5003d20-5519-4882-aa32-d550d8cb3d7d to identity de364b4e-2e72-48bd-8a48-dad1e8d7b0dc"
}
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJHRE1xRVh6MFNySFhJUmFMcUdLQ05BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQyNDZjMGYyLWRiOTgtNDZjMS1iZjgwLWZiOTc3NzNkNTNkZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OCwiZXhwIjoxNzQ4NDYzMzU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWMxMWI2YzQtYzI5Ni00NGQyLTlhZDctNjI4ZDI2MmI1YWQzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fSx7XCJpZFwiOlwiM2Y2M2I1MWMtZTg5OC00ZDY0LWJlZmMtNmQ5MGJlZDViYTA4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.tI2QPGeGm6QfKNMEB0sy68J93-dvaaRFzDK31nGUbB4jijWSUA98smAvCjNk--dAwQ9v0BwMQt1uYy-qKBJ40bqX01KNSvy_8MFWot-aIr8v21_ZWRM6vD8QIkg7qknv_oVA_VysPXsV5GrLj8dvih6NO2hKEffkc9wlvTs_Akq8w6hgYEXj0ngLNCM1CFy5KD0s1dHqSZHdYP0DH9B3-_ts5xks9AhQl4iup4N1D09Hmv5w5TFujSKeX_qvf8OJvCM7r1ASFt79IPP9PWnntzBA4jhGxSygtySt7XmC6K6SXCI_aVdIZr_81IhbcChGEUX9BOIR6BhgefsES_1EjA' \
-d '{"standardRoleId":"1e705604-16d1-4fb5-ac5e-d79a95bea21c","identityId":"91f9c617-ce3c-4828-82c4-e25d6867a9d4"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "57efb8e2-4f15-47e3-8a5f-e3a75482e590",
"identityId" : "91f9c617-ce3c-4828-82c4-e25d6867a9d4",
"standardRoleId" : "1e705604-16d1-4fb5-ac5e-d79a95bea21c",
"createdBy" : "4246c0f2-db98-46c1-bf80-fb97773d53df",
"createdAt" : "2025-05-28T19:15:58.189217Z",
"updatedAt" : "2025-05-28T19:15:58.189217Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 1b07ef52-b7f8-4f22-86e0-b764b0db830e to identity 91f9c617-ce3c-4828-82c4-e25d6867a9d4"
}
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/0c229002-004d-4ce4-be2d-d69488107e5c' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJvMkJHcFRhTm4tZFBpbGZpdXVXM2NnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdiNzU1ZThiLTJlN2MtNGIwOC1hMmUwLWU2NmU3NjMxZjZmMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OCwiZXhwIjoxNzQ4NDYzMzU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjEyNGI4ZWYtOGZiZC00ZjJhLTg4YzMtOWFiMjZjMTRhY2ZmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.gRjLT4m9aJNLa8uvh3i3L7Mo14cnmTCABjytlEY951lH81q8KsOUMqmidcAbYBJN7CMtZq_evjLmxvOg6N7JsB5LbOKnu03LO4rMracW-81eFUie9kCnx1yXDpqcYUaRX-Hv3Q1ROJwLbeGdo0nfKQCKgQURTUkmwE4YRnKND_144qAncZz2PMJH-ydvt7PCsZBwf-9vuaBn01Qjh7Nvav0S5vBwtcwRC85o8Xa1IJ1V-vO-GdTYcK4MR7c2daFcgduqYYri1nYejI2fgSLDvB9uJj_nzK3xCEDwZZgfq95g72zjHQRV1s0sU0M5Wp3hGAIOdck7Z90DrEfhlasU0A'
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiI2YzZXRXlXWTZxZDZ5RFFRZmNYUFVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU4N2ZhN2MzLWFmMTAtNDUyMC04Yjg0LTc5NzAwMzNmNTJmMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OCwiZXhwIjoxNzQ4NDYzMzU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzA5NTU4NTUtZDE5Mi00MTVlLWIxMGUtZjRjMmY5ZjgxMGM5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ONKpy6JZk3VtlQwqr7ERg64xiuzt4oPpT60Qn1FxVd-CTYRIeals9rM_Ny_KiPsAIApTYXcM2KfkkUTbvPPaNwqH1g0TaLUfIFdiexqovz8GCASFvJ1_rVifEDGv5SeWvF9EY6ME-F8k1IFFP-wS1Fp6ApN2yRmzUqQLEo7zLDtnDpfXle83rSA5UvcWmBEUJjFDBYHotUkIptWiwju2aEypoaqHzNtF6zCDfY3lCUjHEcj5_P4Clud1T6pLh59Tns54-tdRPIKa6nFExvGNKXfI5xbliaUdMn5UaCRM9lH41FaTxrwRwI3nsvs_J4VK663yLM98aPQ9rhpoCdXcoA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1018
[ {
"id" : "a8ab2675-c1ba-45a9-8365-b78d7931315b",
"resourceTypeId" : "f3e99ebd-32f3-40b2-8ad2-5cbd5fd25c91",
"authorizationStrategyName" : "Admin",
"createdBy" : "f6387d1f-930e-4b1b-9787-b9c52f03584b",
"createdAt" : "2025-05-28T19:15:58.348387Z",
"updatedAt" : "2025-05-28T19:15:58.348387Z",
"_title" : "Test Type 63 Admin"
}, {
"id" : "c2ca17dd-b75f-4922-934e-e8ba1d92b798",
"resourceTypeId" : "bddc23a0-8742-4e63-b25b-8862c6a73019",
"authorizationStrategyName" : "Admin",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.488131Z",
"updatedAt" : "2025-05-28T19:15:26.488131Z",
"_title" : "Customer Admin"
}, {
"id" : "f591ce64-cedf-4384-a2a1-bd6b04a15b1a",
"resourceTypeId" : "9f805f92-366b-4b18-9c5c-7248d29d2930",
"authorizationStrategyName" : "Admin",
"createdBy" : "fcd7c03b-a7c1-43fa-94b9-8e7f9deb63ec",
"createdAt" : "2025-05-28T19:15:57.395016Z",
"updatedAt" : "2025-05-28T19:15:57.395016Z",
"_title" : "Test Type 51 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/0f6fe866-a6ad-4247-803e-2730207fde94' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJRTFFCVktRcHFTLWJiMVZOdzBOS3VnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI3ZjJhY2RiLThjM2QtNGZmZC05MzA0LWU4YmExNTY3MjcxNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OCwiZXhwIjoxNzQ4NDYzMzU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTkzYTkxYzEtZTBjYS00ZjVkLThjYzctNTgzYTc2MzY2NzVhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.w4MKxJUkDO7ZDkdq6aem0F4AEDf4nkFvRPf5Cn9gZLx7t2iNeN4LbQsucAoaGcR5xuq-MwJyQ9BjKzJwFzxdFQPcMEma_VJ_dd9b-8PTCCcn5ZrwljczMpLzdD86i_6sWwQaZIvk1_gDnOw8kUT68I_JOqRyljCKGW07bTyIOgw82oQJBb6Hvwmkjq6pCOdcoWLWfHBI1A24bcSc2cokfII0BIIAScjiocifaUVKNYyyz5H3-l_o2a4fASo0yeT45tB3YzwHBL4CBt56533tWB6FvvP8XcvwL0EvPFGwxzp6cO_cUYqULXSacjRdAmNZcUl37XLJLCxOI3vE81kX5g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 338
{
"id" : "0f6fe866-a6ad-4247-803e-2730207fde94",
"resourceTypeId" : "5acb89a5-abe4-46f8-b3ce-e5d46cc13a31",
"authorizationStrategyName" : "Admin",
"createdBy" : "f2cec91d-7c45-49ff-a27c-1781f0b5cd20",
"createdAt" : "2025-05-28T19:15:58.701928Z",
"updatedAt" : "2025-05-28T19:15:58.701928Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJkS012dWNFNlhLQmk4LUdZbnRCS0tBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgyMjg5ZmIzLWIyYzAtNDEwNi04ZDAwLWIxMjE0ZTY0ODFlZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1OCwiZXhwIjoxNzQ4NDYzMzU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImQ3NWI5OGExLWU2MTUtNDQxMC04YjYzLWIwNjk3ZDhmYjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1Nn0se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcIjU3MTA2OWQ1LWI1ZTAtNGQwZi1iYTY3LTk1YTRmNmI5NDUwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTc1NX0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmM3ZDQzNjctN2QzNi00YzVmLWIzYTUtYWQ3YTU3MGIwYzJkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fSx7XCJpZFwiOlwiYTBmZjQyODYtNmY5Zi00YTEzLTkwYTEtMzZlNWFkNmM1ZWJiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzU4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jE208HWxTeyRywM3pFLqGyyUKNZtnRRi6FrS2lZmN0gFW4HOAkYSRFVsoqRwjio-RO7iuhMyS5hRouR7GjcoEhmmCjLi2-bjsmsCUGHLipRp2Z0MTUUM57K_m3ClEwZxRdeF9ZNde3CmFJpJ4nH3oNyOvf0_Ij-SW6dlTe1LbjDsW-m-rWKQ20ws63XhTVohKwBaEp3mLrQErUbajLhk_DZ5dmt6pE9aOzo4UWg-E5UuXFQBK2OyQ7gD4U5Rk-fW-YBkrP8Mx4C7FrQ2T06-5NXEyMDq-Q3aLUUY7y-luFjIuO9n172QiYQHfRvkkU6Qfzh05Ha7Roy4ZJEwWiYuMw' \
-d '{"resourceTypeId":"62818b11-0630-4581-b542-6db692e2a258","authorizationStrategy":"Admin"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 335
{
"id" : "0b7baa9e-5e07-431b-b935-8b543852a893",
"resourceTypeId" : "62818b11-0630-4581-b542-6db692e2a258",
"authorizationStrategyName" : "Admin",
"createdBy" : "82289fb3-b2c0-4106-8d00-b1214e6481ef",
"createdAt" : "2025-05-28T19:15:58.625503Z",
"updatedAt" : "2025-05-28T19:15:58.625503Z",
"_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiI3WGUyeVBqSUxZcVZ1X25FYzNac2ZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJlZTIzY2E3LTZlZWYtNGUwMC1hMThiLTdjMzNmODc0MzE5NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc0OSwiZXhwIjoxNzQ4NDYzMzQ5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzFjMjE5NDctMDM0Ny00ZDcyLTk0ODYtZWZiMjlmMGY1ZDBjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzQ5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.opKwoBtBKLF5vyR0V9V7pOGBSqma4TdEnKYpNciKhiK7rkOAEP4WnEjrYLSEXfNQ6jml9HTC3SZGY3TpuyxDMnXn_JWQ2Y-6mX9El0rctMCYtWXba11aUHga7zT3N02cQ-E6g3kvSU2TQsZST7l6I8IBQTojFr8BGSO7jAChhUj_STS3au4tYvYd-vr3XU87_LbHMB6PnaWUagi9gFWm7XKGJ_qpHCN3YoLkB6XG3BpmIYH2pvXFhyS6TrFaq8r1kVeZL1VRq4iNr5whIPI7KyMPkftCvfRt7jb_EwIhndhksmNzovpC0vPl41qkgfLvCoc7LTs9SCaR2rhowN19UQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1561
[ {
"id" : "88664ba3-b800-45ce-95db-24f6b4050379",
"resourceActionId" : "53de779b-c9f3-4e4c-b258-5188eb323ab5",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:25.498149Z",
"updatedAt" : "2025-05-28T19:15:25.498149Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Update Software Deployment State in Admin Standard Roles"
}, {
"id" : "018596e6-2559-4bdb-a617-8367a2058572",
"resourceActionId" : "828c36be-1e1f-4c05-a73a-561a9efb67d5",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:25.709822Z",
"updatedAt" : "2025-05-28T19:15:25.709822Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Update DNS Zone in Admin Standard Roles"
}, {
"id" : "254272ad-999a-4560-a902-8e59321ab756",
"resourceActionId" : "45cd4a87-dfe9-40bb-a82b-9967718dec02",
"authorizationStrategyName" : "Read-Only",
"includeWhenAbove" : true,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-05-28T19:15:26.070078Z",
"updatedAt" : "2025-05-28T19:15:26.070078Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Read Container in Read-Only Standard Roles"
} ]
Get Action Inclusion
GET /action-inclusions/{id}
Authorization
This endpoint requires read
action on the action-inclusion
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
authorizationStrategyName |
String |
true |
Must not be null. |
includeWhenAbove |
Boolean |
true |
|
includeWhenAt |
Boolean |
true |
|
includeWhenBelow |
Boolean |
true |
|
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions/11ff2ccc-ee3b-43a9-8bde-83915ace869b' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJqdF81dXRlWHdZMjY1SEFoOEMyamJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIyZGRjZjM1LTZlMzUtNGRiNy1hMTQ3LTgzZTY0ODYxOWJlNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MCwiZXhwIjoxNzQ4NDYzMzUwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjhkYjExNDctOGNjYS00M2JiLThiYWMtNjNjMDM5NTdiY2QxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.F3Byal1iCh1ITjUHMPyddaJ2fU9_0H_ZY8s1XHBwzck50F0zvFRN4q0EaiA1KHhQwIHw34r4mMs6Faa02uohlW7e11goMcPqxFiths5Zrk4n_6ya_TiMgS_HfAYCVW0bc3hDPhyBFmyh3E4Tdgx7TNVB6CJITvzDD83FcWON4ayff8ISnet4rAHVwdonniL-1zghA2-0odxcnxcyaajvV7VI2ondLdh8kASEfOnpOguMM0Lp3frzDKBsK70B3VV4xUIHav3k0Ur95piTlpOgc0mOGXImm-DMrkj3_zwCAF3_qMT5yOXlw1EczPnRZ3qf2T0zqQKHjfsa5XaQLSLZAA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "11ff2ccc-ee3b-43a9-8bde-83915ace869b",
"resourceActionId" : "52c572f7-dfbc-4d81-a0af-e04b89e15826",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "8250cd78-199f-49de-91e4-a97033cc3683",
"createdAt" : "2025-05-28T19:15:50.760333Z",
"updatedAt" : "2025-05-28T19:15:50.760333Z",
"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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiI0TWNjekwyV1NIMGJkT3RJdmhsZVpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjViZTJiMGFkLTZjMDAtNGE0Ni1iZDQ4LTJkZmUyZjFkODY4YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MSwiZXhwIjoxNzQ4NDYzMzUxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTkyZGM0ZDItYjNhMS00OWEwLWEzOTEtYzM0MWMzZmZjY2QwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUxfSx7XCJpZFwiOlwiNDZlNDM1YmItNjFkMi00ZmIwLTgyYzUtMDA5ZTVjZTZiMDQ0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.OhDjSrYABBjGOIq5ltUs3mvAw6wZ24JgqwAQXX4gA7bEVxfFR9Y_UQX3XxFErtN74J312p0xEsgbBygl4wbf6q1K0fAkptjoOTVUzyj4MuGd8_f_yEO1TPoY7YIeFWQdRO2wr-tCnU0ZNu70jFJ5pglAj88iHdaW2Vzq6MrqVKa6syKECYGoNV1ihnlO0bx4K6CuZJcNWpbQ-Ybm5IX5VLoc02LLiBunKhlqjV4KAai2i6MOALd5VDu0QIWTykpmf7TwUyKY98sULI1cGSe5-km3nyLXMEFR4xjlWKaGR814mllAiDP0ZAYl1IMfzfAPYf5slMTSzeXO5hKSBN-4bg' \
-d '{"resourceActionId":"549711aa-3e22-4912-b08e-ce4e24f693a9","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 526
[ {
"id" : "2b861a3a-9e61-4b99-9efd-7a7cbaf63895",
"resourceActionId" : "549711aa-3e22-4912-b08e-ce4e24f693a9",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "5be2b0ad-6c00-4a46-bd48-2dfe2f1d868b",
"createdAt" : "2025-05-28T19:15:51.442942Z",
"updatedAt" : "2025-05-28T19:15:51.442942Z",
"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/31835ddc-f118-4155-a5ba-d353759e1c99' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjM3YWYxNzUwLTdhZTktNDk3My05YWRlLTA3Y2YwNjI0YmY5YyJ9.eyJqdGkiOiJjSjVsUExYSDBBaWJRUnZNQjhNOWZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRmZTk4ZTI1LTlkMjMtNDc2Ni05NzY2LTQ5YmM3YzQwMTNkYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0ODQ1OTc1MSwiZXhwIjoxNzQ4NDYzMzUxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjU4NjViNDZiLWVmOTAtNDJhYy1hMDI1LWQ5NGYzMDJjMmJmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImY4NTU5MWM3LTNhNzAtNDk4OS1hOWZlLTVlNjhlYzczMDEzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjNjOTU2NjNjLTg4ZmQtNGE3NS1hNTlkLTZiZDE5ZjQ5MmRhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcImEyMTc3ZWRiLTU3MDktNDBlNC1iZWJjLWVkYWM0NGNiZDU0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcImEwZTY1MDU1LWFmNDQtNDRiOS04M2Q0LWVlMzRiOTFiOTZiOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjg1YzUyM2VlLTc2ZTAtNDZlZS1iZWExLTUwODQ1NGY3ZWViM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyMn0se1wiaWRcIjpcIjVkZDMyNjYxLWQ4MzgtNDc3Ny05MjA0LWFkYzNhZDgxM2VhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNH0se1wiaWRcIjpcIjNhMTYxMmVjLTZlOTQtNGZiZS1iODI2LWQ4YTA3NWMwNmI0M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyM30se1wiaWRcIjpcIjgxMjIyZTc4LTFhMTQtNDgyMy1hODgwLWU0ZTQ4N2RhZDkwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTczOH0se1wiaWRcIjpcImE2NzI2OGIzLTYwZTgtNDI3Ni04MjlmLTNmOTZiMDBmYTNkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0ODQ1OTcyNX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjhlZWQwZWUtNmE5Yi00NjY5LWJmNTktNzQ1YTc2ODNkMGI0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ4NDU5NzUxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.XTs-VO7uz2NCWfPTDQhFc1S-HGuwfT4tRCTp7e3tob5N2xg1k-vAZNg19YfBNGnv4jr40ZwjDKj7Fve3azRSp6YtQeyEZ95oBk-_hBcvU_CZkxnihn1IIRFUXx9zgAKZ-_jLOpciw0j5HCrLFHThG5J_gOGvfqIZXpwDsYAazxa2y6CsluPMhqojEh_KhxICUdnjda-iysbqqgy2mMtYb5sKZ8SqAO8Etm6b4IIwKsx57WxN6T8y3TllmYS2XESfDxdpSBgt6MOTFiuQ-FRxB9pi8nVoooNjbLpADBFqWAgApUsR86cCmCy2QDO2o8TI3lqYyLjeuWcfDRSCxAOGLw'
Example response
HTTP/1.1 200 OK