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

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

DELETE

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

200 OK

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.

201 Created

The request has been fulfilled and resulted in a new resource being created.

202 Accepted

The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services.

204 No Content

The server successfully processed the request, but is not returning any content.

400 Bad Request

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).

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource.

404 Not Found

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:

Table 1. 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 property,property(,ASC|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc.

Pagination response has following structure:

Table 2. Response 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

This endpoint requires masquerade action on the masquerade resource type.

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.
Must not be null.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiI3S1RHbEJzSGEwSi1BRGtBMW5yandBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkzYzNkNzg3LWIwYjAtNGJhYy1hZTZiLTcwYzQ4NDMyMGQ0OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3NywiZXhwIjoxNzkyNjY0NDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjNkNGIwM2QtYmQ5Zi00NjVjLTlkYzYtNGI4YTNiMzZlM2RmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZDaAhe18vSZv2EyBrE_My9UbUCjv1XAM6yQinNPkJvqrGxdqmixbK3YAjf97mtvdvm8uYaSv89KqJd47jmcFBLjtwIMld7VdpdeQ1vqhXUTra9KnV9mlPf_1bilg5YCQF7YoVl_9RkLIX-IMYIPSSEg9z2hDZqUPPorL_EG76ng5idtip9G9NLJtQCHD5O53AwAyvP8x4smjKnJZjeurS3juKLYCIBIEJPrsVu7cT8XZpKmATa_u8-GvuWqB4-Zow1v2yS4Vh-61XCILDkyn4gc6Hm7ND13XY0rAxHH0ktzP3fvsRT0O2hLk5JgkC4-anxSYplt2ZMR0ptr2RIvRdQ' \
    -d '{"identityId":"75eb8ae5-dd33-4586-94a8-3af3321eddb2","audience":"io.netfoundry.test","claims":{}}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1432

{
  "token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJveXpubzY3YWowUE5DZDg5TkVacjdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc1ZWI4YWU1LWRkMzMtNDU4Ni05NGE4LTNhZjMzMjFlZGRiMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTc5MjY2MDg3NywiZXhwIjoxNzkyNjYxMTc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6IltdIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.pEkzS5bSsNPDDeQ9XhvxYKT6ttrUC-rAxO9IzbWpLOmhwMYvY-JCiEghNVdXYF-Skbu2yfOojopJDsn2i6bO0hCP--fdyageDUaI2R0IgVFBWVgnbpOry48yKqQPYRyw__l6qkr0EFOqMhXesxrMg6L4gIYq-hc5VWChRw3n2cDDMvERiRW1pe_9CntO1uvjKfuKkL9LCmJuTdKEcbFRnC1CgRJgcn1wV9uDF4xaoMEJUTC9GFVlr9c9NJVIljHCQdciT6LFmRhykbOxVB62Um4SdXNne3LplyOZGGHQuiZdK4otfWNZQugz6eX33smH81jsNCulV7YUVTretNqU0w"
}

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.
Size must be between 1 and 256 inclusive.

[].code

String

true

Must match the regular expression [0-9a-zA-Z.]+.
Must not be null.
Size must be between 1 and 128 inclusive.

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJzeFdqV0N0dGRUTXFKa3N2eWVRWUlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY3N2MyNDdmLTNmYzgtNDY1OC05OWM0LWE0ODlhMWFmZDI2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MCwiZXhwIjoxNzkyNjY0NDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2ZhMzIyZWUtMDM0MS00NWMyLWJlZjctMzYxMTk5MmM3MTg4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Yc_bhqt3STFTqiV_BPcBXTLeF6YI_dhOvO0698pAsezX4jPH001d1oD8nyon2SKHiu2UjFxnGd8s_tK36SWgGI0LpeP4-HjDaQmFWV4AMsWXM-E_H1Lkzb0p7-C3B5Xm1vLi6Za9wni0CrNO2vVhPQvB-K-5Ttre1ucUxsMeDmsZKQN2d7klTlqDr-0k1zfYCCGchie8RuXEj6xplbsAPgPMcHiW1b1zR010XXrj2rn8lS4bkF913NuZzpdSZ1c3qs1xqhRL1IBh4FintGVnrH1MK3akqHNPFNn0PH8tQc7gkqMPyywafEJuv5YLj-Z9vNI7SIchYNXoqmQkwgMBHQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 878

[ {
  "id" : "2fd7bb17-a2e0-47ad-beba-9a22bd339268",
  "name" : "Test Domain 75",
  "code" : "test.domain.75",
  "createdBy" : "7b40ce7f-09c0-4edb-a697-6fea5623be05",
  "createdAt" : "2026-10-22T09:21:13.349519Z",
  "updatedAt" : "2026-10-22T09:21:13.349519Z",
  "_title" : "Test Domain 75"
}, {
  "id" : "00a8c903-af83-4a27-bb0e-bdca1d85ddfd",
  "name" : "Test Domain 64",
  "code" : "test.domain.64",
  "createdBy" : "ac229bf7-c1a8-4106-b546-70e510e81988",
  "createdAt" : "2026-10-22T09:21:12.038302Z",
  "updatedAt" : "2026-10-22T09:21:12.038302Z",
  "_title" : "Test Domain 64"
}, {
  "id" : "d21b1a59-e1a1-4b62-adb4-5ae2b0111a1e",
  "name" : "Test Domain 66",
  "code" : "test.domain.66",
  "createdBy" : "454ec487-4bf3-4a65-83d5-ad2a82287d6a",
  "createdAt" : "2026-10-22T09:21:12.098284Z",
  "updatedAt" : "2026-10-22T09:21:12.098284Z",
  "_title" : "Test Domain 66"
} ]

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.
Size must be between 1 and 256 inclusive.

code

String

true

Must match the regular expression [0-9a-zA-Z.]+.
Must not be null.
Size must be between 1 and 128 inclusive.

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/d7517751-35d1-4c2c-a732-ef3c44022a0a' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJoY1YzWk5aV1dpcTdqUkx6U0puY1JRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE3YjI2ZDUzLTJlOGYtNGY0ZS1hY2NiLWQwMmMwNmQ1NjIxZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MCwiZXhwIjoxNzkyNjY0NDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGI4ZDE2MDQtMzE5MS00YjU4LWE0ZjAtMWI2ZjNiN2NkYjMxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.K63btcKLj5-UnfNweM7Iysa9vDkJS3D5-0EZRJYSCm1SFGoHHHGe2kFIMLlIu_CgmOrUrtHaWtHiAwphLt-wNX6shfqcLnYaISf_TePgeY0aLLu_yVf9reoHDesKsvcXzBxm7LTiOX-5E8Nx9QaGPiPYoFvgJTYJFDv66mt9_tg5gkQ4JZEAYO6XN-io_RN45GipY-mwAK7iGwzyp7NetOT7GPUwBZ6ke7cMkXIuMAwLtqnp6_RhmKMTEvDG8uU2VXD9yz7qSKzqnQEPFDrHXpiY5iiK9XP7EoVb4JB5Hw4Rr3pBv-LCiUsZ05hWg546ERpdU92beZPWrhAtMBh6NQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 288

{
  "id" : "d7517751-35d1-4c2c-a732-ef3c44022a0a",
  "name" : "Test Domain",
  "code" : "io.netfoundry.test",
  "createdBy" : "091d9c7e-bb3c-4d47-9aa9-7016c587bf0b",
  "createdAt" : "2026-10-22T09:21:04.417211Z",
  "updatedAt" : "2026-10-22T09:21:04.417211Z",
  "_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.
Size must be between 1 and 256 inclusive.

code

String

true

Must match the regular expression [0-9a-zA-Z.]+.
Must not be null.
Size must be between 1 and 128 inclusive.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJSWGs3TDREN2diZVA1d3huWWJ3THpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJkNzM4MDFkLWRlZDMtNDQzMi1hNTNhLTFiY2Y5NDJjMDUzYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MCwiZXhwIjoxNzkyNjY0NDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDBlNmRiNTktZDM2NS00YzNkLTk1NmUtNjYzYmVkZGNkYTBjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.UCjHxTdszmBlRuClNvapEgOFqxtQ9ZAyB6LLzIWpUL7CiFBe9MWk5jSAYVqkFLe7u5h90Dy4u7S7eqNOyHFv67ljInu3iEvi6A0eC-h7ZGxnnSsbteLtX8YWnXnk8_PpVgPEo0GXuWugN3JhI3dBPjDUMUBnls7lFKwfsoEQLYOLRD0pUW680PXlUEUTXle4YQpaKklixqk6WlV3C-la6TtCoRzNMFDI-5Zrf6clca3KKEt752R1Z2W2XylpL-jZcxnUMImKgYSA7MeB6a9HZeo7RSwIqwblnOlLnZYJA8cCES3Kc2FwmP4i5Z2TSg7pHMHcGNWLFcgYIMN2vT8Nfg'

Example response

HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 288

{
  "id" : "d7517751-35d1-4c2c-a732-ef3c44022a0a",
  "name" : "Test Domain",
  "code" : "io.netfoundry.test",
  "createdBy" : "091d9c7e-bb3c-4d47-9aa9-7016c587bf0b",
  "createdAt" : "2026-10-22T09:21:04.417211Z",
  "updatedAt" : "2026-10-22T09:21:04.417211Z",
  "_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.
Size must be between 1 and 256 inclusive.

code

String

true

Must match the regular expression [0-9a-zA-Z.]+.
Must not be null.
Size must be between 1 and 128 inclusive.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

name

String

true

Must not be null.
Size must be between 1 and 256 inclusive.

code

String

true

Must match the regular expression [0-9a-zA-Z.]+.
Must not be null.
Size must be between 1 and 128 inclusive.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJBN01PcHpmQUVpbDFYbGZtSEprWDRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgwNjMyMmNlLWE0MTMtNDYzMS04ODFhLWYxY2YzZjBlOGE2MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MCwiZXhwIjoxNzkyNjY0NDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTEzYzU2NmQtODM3Zi00OTY3LTliZDctNjRjNzI4Njc4MzdmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Ss7-MmlXDd-yUkXFHj5m3KxWmRgsVkFFSNEOdbJ7qz6gtl57OUtDLvVgrhQUI83PsY1j0DpKUk0FtTmlmATU5dw9_oUAIJXLDoOJKu9faQdNVNiZr9EPjfhxbtM5VWdgP29kdmKUp-MgBLb5BNBUeBOt4wHuXNDhBkCwoQ5VScLRFqREHD3VwpE9ruXxp1Lsctdtfmo21FdYk1mp54PXQO7zHtz0lzcbyDz24gp8CiJ5guVf8Wzsb75ZOlp1r0HlRGiR9yqNHobla2iTwwZkRzviHBIJsInBcmTAcg5avF1iAKUIrN1qwvLAcReYnzGExzAOHE5ZHyZe9nP10m41rQ' \
    -d '{"name":"Other Test Domain","code":"other.test.domain"}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 299

{
  "id" : "4e06baa4-6644-41c4-b9d9-1bdb8db4fd90",
  "name" : "Other Test Domain",
  "code" : "other.test.domain",
  "createdBy" : "806322ce-a413-4631-881a-f1cf3f0e8a60",
  "createdAt" : "2026-10-22T09:21:20.890658Z",
  "updatedAt" : "2026-10-22T09:21:20.890658Z",
  "_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.
Size must be between 1 and 256 inclusive.

[].code

String

true

Must match the regular expression [0-9a-zA-Z-]+.
Must not be null.
Size must be between 1 and 64 inclusive.

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJyUDBCVFBJQ2xoelBiQlRoZmNDd0tBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY2OWYwOTBiLTExNGItNDljMy1hNDY2LTdjYWViYTE3MTI5ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MywiZXhwIjoxNzkyNjY0NDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWNmZmVjZGYtNGIyMS00NDRiLWJlMTgtNmIzNGI1MmRkNjhjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.oI5VXCQQ0jeCqqWi2gIZShGzb2Oj0Lo9M9pYc0tZITUoZBYEZz0K4I4oGQFshOipx_S5D_jmsoPdEHXrBOCP3hBY5PUHgdmvNYAFQTUTo4XMV-O0T5MaO3gT4r9FI00Id20vb7roesLP9MJPMQek01JQBX5vxIfy92xvPGtBZY2FLOV4uc9vl2mfRo_7P7Mojw88FuayJjB-G9vNbj91DyHG4M7ZI5GMNIJKoCBrORMzWZ5e0fzsoEPpedoJ7UowS5t5MwWmCPFU9BW8a7CYMCj-zd_uvv_BV7iPxO7NnJDzdanz0TkZ-B_rvTg_cIXs7nGphQVQconbweh1BoyKlA'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1371

[ {
  "id" : "845a83ca-2d77-4c05-b859-3ff7797e5ecd",
  "domainId" : "09706ae6-4375-43d9-85cd-f4467d20ae2e",
  "name" : "Customer Connect Access Policy",
  "code" : "connect-access-policy",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:59.149397Z",
  "updatedAt" : "2026-10-22T09:20:59.149397Z",
  "parentId" : "ec5b28b1-620e-4790-bbfc-9bc488bde4b3",
  "root" : false,
  "depth" : 1,
  "childrenIds" : [ ],
  "_title" : "Customer Connect Access Policy"
}, {
  "id" : "bf5ba5c4-86b3-4318-b304-a4b7b25429aa",
  "domainId" : "52b6dac4-1fc9-484c-ba37-9ce350f75d83",
  "name" : "Role Template",
  "code" : "role-template",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:59.836495Z",
  "updatedAt" : "2026-10-22T09:20:59.836495Z",
  "parentId" : "96aeb431-421e-4511-86c4-27df6eae371f",
  "root" : false,
  "depth" : 1,
  "childrenIds" : [ ],
  "_title" : "Role Template"
}, {
  "id" : "07463fde-6a64-4e52-9b23-a0d11532fd5f",
  "domainId" : "b4593456-f2b4-44f1-86ff-3799a0ddb696",
  "name" : "Test Type 10",
  "code" : "Test-Type-10",
  "createdBy" : "e57e73ff-c68d-4b29-a55d-0e4e8affd579",
  "createdAt" : "2026-10-22T09:21:08.259970Z",
  "updatedAt" : "2026-10-22T09:21:08.259970Z",
  "parentId" : null,
  "root" : true,
  "depth" : 0,
  "childrenIds" : [ ],
  "_title" : "Test Type 10"
} ]

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.
Size must be between 1 and 256 inclusive.

code

String

true

Must match the regular expression [0-9a-zA-Z-]+.
Must not be null.
Size must be between 1 and 64 inclusive.

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/06d745a6-05ad-4e8a-8702-c4f7e4d99094' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJNY2Z4YXotUU1mWXBYQm1VR1VQZy1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRiYjdiNWE2LTU2NDEtNDRmNS05NDU0LWU0ODY0NzY3N2JlNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MywiZXhwIjoxNzkyNjY0NDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODYyMzA5YWUtMzk0OS00NjllLTk1MTYtMjE0NzAxYjZhMGQ2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DBdKDFJzXaWFY21IpAq0bTtdDNge5Zwg8nCGRRsguthSdbF8GSGfBWq0cuFgcscyhF3TWXcDcYV_Vin3jKKQxbUTHVfRGiQGWDVMrP_edqyx6qGivX8ze2f7g-NQZxkxV_SrfY0ZV6CQOM269GL4nlehWnAWtFyB91Ww7BvKX5VrlwMwDVqSvWiz7YZLUvVjOUQ8ht9Nc7ktUkD8TCYtfGurKQmdHq5vcqJjlkYvrWlHxxAaqUBDAQRSQU4j5k-n-sSQk6bYIvVLtc-yFYlgINdtr0OD2xZ0FhOxwvrTpt6JueeRBPAVrvvD6iscSmeLb2pds4zAGeGKWS4eY3ffPQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 406

{
  "id" : "06d745a6-05ad-4e8a-8702-c4f7e4d99094",
  "domainId" : "d7517751-35d1-4c2c-a732-ef3c44022a0a",
  "name" : "Test Type",
  "code" : "test-type",
  "createdBy" : "567b4f4c-3881-4517-958c-b10df05087b7",
  "createdAt" : "2026-10-22T09:21:04.447748Z",
  "updatedAt" : "2026-10-22T09:21:04.447748Z",
  "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 the resource-type resource type

  • read action on the domain resource type

  • read action on the resource-type resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

domainId

String

true

Client must have create action under the annotated resource.
Client must have read action on the annotated resource.
Must not be null.

parentId

String

true

Client must have read action on the annotated resource.

resourceType

Object

true

Must not be null.

resourceType.name

String

true

Must not be null.
Size must be between 1 and 256 inclusive.

resourceType.code

String

true

Must match the regular expression [0-9a-zA-Z-]+.
Must not be null.
Size must be between 1 and 64 inclusive.

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.
Size must be between 1 and 256 inclusive.

code

String

true

Must match the regular expression [0-9a-zA-Z-]+.
Must not be null.
Size must be between 1 and 64 inclusive.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJ4UFhuZUhMR1VQVm9zMWhua3VIMVpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIzNGNlYmEzLTJjNjgtNDRjMy04MjFlLTVhNzQzYzA3MjQwNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MywiZXhwIjoxNzkyNjY0NDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTE5ZDMzMTYtZTRlZC00M2I1LWE2MzctMGQ4YmU3NjhkNzgwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfSx7XCJpZFwiOlwiMmQwYzhiMjctMWY2My00NmQwLWFkMzEtYzMzYWIwM2FmNWI3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfSx7XCJpZFwiOlwiN2NhNWNjNDctYjNmNC00MTE3LWEzYzctNzQxOWNkZWFkYWNjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ITIw_hdtasULFJ0zZM7IHLMBJx1wCTQi9CnmYlg2GaOJv0RB9Y8sKQOoywA5-94o7BBZ28-JrI4pYgTLFmJdfGcY2Bh-hFwX3gRmcQdj5y0-XGOCUApIduEz7vWNVSfl9VxF4oq3kTBymnut_XQw4F4oxogtCstBkBetiACjBVCBGhl2P4AxTbMVXc-xWYm8LGhsn3QPinQ1eV58iz5UHPb3jiUGPZ22xnWb24QJaL-at_KT4inwHMH1EtOsUCqk5CJmzvSYzAKmGhO5tydfJWIDeeCicmqe-trMKkKnOVW71U4Yl4kdoR3c1FvlC7MgdeGTWfSfTHdcGPAOyCbQrw' \
    -d '{"domainId":"d7517751-35d1-4c2c-a732-ef3c44022a0a","parentId":"06d745a6-05ad-4e8a-8702-c4f7e4d99094","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" : "91ec6137-1b1a-42e3-a672-f8125dcd2d49",
  "domainId" : "d7517751-35d1-4c2c-a732-ef3c44022a0a",
  "name" : "Another Test Type",
  "code" : "anoter-test-type",
  "createdBy" : "b34ceba3-2c68-44c3-821e-5a743c072406",
  "createdAt" : "2026-10-22T09:21:23.651214Z",
  "updatedAt" : "2026-10-22T09:21:23.651214Z",
  "parentId" : "06d745a6-05ad-4e8a-8702-c4f7e4d99094",
  "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.
Size must be between 1 and 256 inclusive.

[].code

String

true

Must match the regular expression [0-9a-zA-Z-]+.
Must not be null.
Size must be between 1 and 64 inclusive.

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJyUWZMdnhuLWhFOXlVNjQ2VGd2Z0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFhN2FkMjMwLTE0MTgtNDQzNy1iODRiLWZmZDVhNmVkY2NkYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MywiZXhwIjoxNzkyNjY0NDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzM3MjFiMjMtZTFlZC00NzM4LThhZWYtYWFhMzc5YzYyMjM2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.gem6_6lc4NshkYv85lyT8orUySaTCfCvvavZCuVDdCJBNc46P4UH2QQZJkMW5sCSk2I8suVPFGQzUhmscTzia964Twfd6Umw9vBsJSla3cB1Wfs2EJ2SeNCu63NzK-rlEf6z8VjH2ZvoMKcdbUEPUO-TRu8B7hDEC14PXUVDf8mGoPM7sfwpiFfBee7IymIz4Xus1aGA6mOQEeXZfYDgU-1B-8b_UCR2J0jFS1cqJxyE04bcxCGUmr2g6ENKTk20CMILlJvFA1y7cbdWATAsLdi_n4eX-q0cb2quMXie_PTljEnSiMDUmIeyQDJQQ-7U3Ah83p0oLnxh-S-0STp9fA'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1115

[ {
  "id" : "850551e7-37c5-4e6b-8ffc-a147ec612caf",
  "resourceTypeId" : "82332ccf-7d78-46e3-8c21-4878ae41dbe4",
  "name" : "Create",
  "code" : "create",
  "createdBy" : "1e241c34-aec0-4ead-ae36-e7baa5fd77cc",
  "createdAt" : "2026-10-22T09:21:10.203581Z",
  "updatedAt" : "2026-10-22T09:21:10.203581Z",
  "standardAction" : true,
  "_title" : "Create Location 40"
}, {
  "id" : "eda1cddf-646c-4b92-afd2-16bbb790c559",
  "resourceTypeId" : "aca12075-df6a-4ce1-9253-e1d4219e7b3f",
  "name" : "Create",
  "code" : "create",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:59.896305Z",
  "updatedAt" : "2026-10-22T09:20:59.896305Z",
  "standardAction" : true,
  "_title" : "Create OIDC Provider"
}, {
  "id" : "c1ae2207-4e4e-451d-a324-e6d27ed825f4",
  "resourceTypeId" : "4866f04f-a4a0-4732-a7bf-176f99e5f11d",
  "name" : "Read",
  "code" : "read",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:54.019469Z",
  "updatedAt" : "2026-10-22T09:20:54.019469Z",
  "standardAction" : true,
  "_title" : "Read Identity Resource Action"
} ]

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.
Size must be between 1 and 256 inclusive.

code

String

true

Must match the regular expression [0-9a-zA-Z-]+.
Must not be null.
Size must be between 1 and 64 inclusive.

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/ff710ef0-f2a7-48c2-92e5-5f667921568d' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJyTDc5ZXlZT0ttUDZmdTNsU1otcTF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgxYTJjYWRmLTIwNDctNDg5Yi05NzYwLTdjZGJmNTZhOTViZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MywiZXhwIjoxNzkyNjY0NDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMmIzMTI5OTItNmFjNi00OWE1LTgxMzItMDI1MzU1Zjg4NjAwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Q3uV6tU9p0DpEtkq83Ul3YRKfd6_OTcmC-pah4MeGV8UKULEyJJ_2demwArPB4ptCdcZiSyr0M2mb0W9Ur4j6vg60_XmpNyfUx5lhWf-cMREv-hkFvBJxpSDS2bC1iiCC2gmfBdClKvOcscOpGljWPDwALgopmpP_H6O1PbYyBpVPFJ7PMeYO7OyLBhfhKPn3nQCz4FrzkhM7BC6SAidIsIhYH37PFucsNF--9LIfwHIvtLv9iONkjZHqMI6wsxT71F2gL7FiMxVl0QYTdKQEWrZn9Q2FhY8XTYQoyyABET5781GlGTLD1aUv-RxfcFSaay2iYvPf5sY4Y-IHC3Yww'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380

{
  "id" : "ff710ef0-f2a7-48c2-92e5-5f667921568d",
  "resourceTypeId" : "06d745a6-05ad-4e8a-8702-c4f7e4d99094",
  "name" : "Test Action",
  "code" : "test-action",
  "createdBy" : "64d571c4-e72c-4e86-9bfe-c05cf02ad8da",
  "createdAt" : "2026-10-22T09:21:04.467618Z",
  "updatedAt" : "2026-10-22T09:21:04.467618Z",
  "standardAction" : false,
  "_title" : "Test Action Test Type"
}

Create Resource Action

POST /resource-actions

Authorization

This endpoint requires the following actions:

  • create action on the resource-action resource type

  • read action on the resource-type resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

resourceTypeId

String

true

Client must have create action under the annotated resource.
Client must have read action on the annotated resource.
Must not be null.

actions

Array[Object]

true

Must not be empty.
Must not be null.

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.
Size must be between 1 and 256 inclusive.

[].code

String

true

Must match the regular expression [0-9a-zA-Z-]+.
Must not be null.
Size must be between 1 and 64 inclusive.

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJ2eUtlZndnYlJ0LVpMUjk5MFYzNWlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIwZDBjZGFjLTdkMjAtNDFmMS1hZjhjLTJmOGE4ZDE5ZTAxNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MywiZXhwIjoxNzkyNjY0NDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTEwMWJkOTUtOGRkOS00YmU2LWIyMzktNjMwMGRjYjdkMGMzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfSx7XCJpZFwiOlwiYzg3MzQxNDUtNGMzOC00Yjk1LWE2NTAtMTlkMWNjY2M4ZjQzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.AWSPHcBfgJodA0R4-t5Ok3-XtbV1kNPhsF9shaudfDLYBm4oz36l852ovqSBTOw7g-s23PHb8PWiu46Je4yWPzXUGrvchmfN04qerRJ0gJui5xMtPc5-pR1q90rWxtnQKj4XNK-w5YLPhPKuI5pOxEI5fxPMJu5uyf0BUf5NbBDnLdp_JxH9ug2fW09Z25fZDzUoio07Qmvm458E4d3zS4EJ2goF_rA0rpNjBf_bbbQCPgAUk58kUyk7ZL-VgpK9_LEO464KRXjbrqMhr-lHa30-oHj68HqRkXVso0kaD0F1LCMDqB3nmiyABHaFRuttkbxJ3Bv-f_5xw-ao7pCPWg' \
    -d '{"resourceTypeId":"06d745a6-05ad-4e8a-8702-c4f7e4d99094","actions":[{"name":"Update Custom","code":"update-custom"}]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390

[ {
  "id" : "49d9ff7f-a671-4734-b8ab-63b0fe2a2eab",
  "resourceTypeId" : "06d745a6-05ad-4e8a-8702-c4f7e4d99094",
  "name" : "Update Custom",
  "code" : "update-custom",
  "createdBy" : "20d0cdac-7d20-41f1-af8c-2f8a8d19e017",
  "createdAt" : "2026-10-22T09:21:23.113886Z",
  "updatedAt" : "2026-10-22T09:21:23.113886Z",
  "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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJreV9nS2h1Szdkbzk4Ym9HbzlJV1h3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU4NjEzZmU0LTgwYzktNGU5Zi04YzMxLTE5Mjg1YmIxOWY2ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MCwiZXhwIjoxNzkyNjY0NDgwLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImIzZDRlOGMzLWMxZTgtNGQ5MS05ZmNhLTk0N2ExYTBlOWI5NVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiZGZkNzIxMzAtZWQwYS00ZWU2LThlOTAtZjA3OTQxM2QwZTZmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODU1fSx7XCJpZFwiOlwiOGE0NzlmM2UtNjlhOS00ODhhLWFjNzktY2EyMzAxNzAzZTFjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODU2fSx7XCJpZFwiOlwiOTZmYzZiOGUtM2FlZC00NWIxLWEzYjItNzI2NWQ0OGMyZmEzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODU0fSx7XCJpZFwiOlwiZmMyNzNjZTgtZGQ2YS00NjJlLWFiMjMtNjU2NGY5MDY5YTM4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODU0fSx7XCJpZFwiOlwiY2FiN2U5NjUtYTVjOS00ZWIwLWE5YTMtOTgwNzAwOTk3ZGQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODY0fSx7XCJpZFwiOlwiY2YxNDE2ODUtODExYS00OWIzLTgyM2QtZjcxNWI5Mjk1MWZiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODU0fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.BetBRwrM_G_kGYp6LSGdPQ14Ol8xJQ6MilXSaAP8QIVa1KncCyRm6RurMNmnKYEWPnDEouyeB1q29iui-VyX4VK_ZqumfXedzBx6EZFn1KK2AoLBRYT6clTHAYpCXcZMETJEL6icjbJ-zy2ekBKXQqEUoyeg5_rWuylGYZ_aWdFSRujuPVHkFcIo3tplYPmzKSnfV6_jCLjLWr5y9ws-qFfNVUwl7JowcX9oT0JUWBpeP7lx8PIdLmH_0AdqyS7jRP0QVEj_Y_bmxTOrWjwmBCGKKEQuVHUS18gtCxnAnaR_UqL55O7N6h0BSZeO5bhibTXhg4zP18JQdYqBAXKVfg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1759

[ {
  "grantType" : "IdentityResourceAction",
  "grantId" : "04143287-5bf1-4d11-ad7f-1248b6ede04d",
  "privilegeSourceId" : "04143287-5bf1-4d11-ad7f-1248b6ede04d",
  "identityId" : "e5f14eba-5792-4a1a-bcf1-9fa176637dd5",
  "privileges" : {
    "io.netfoundry.identity" : {
      "service-identity" : {
        "read" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:53.635200Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read Service Identity, All to identity e5f14eba-5792-4a1a-bcf1-9fa176637dd5"
}, {
  "grantType" : "IdentityResourceAction",
  "grantId" : "e713613e-c414-4af9-abc0-23b2e9cf1a72",
  "privilegeSourceId" : "e713613e-c414-4af9-abc0-23b2e9cf1a72",
  "identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
  "privileges" : {
    "io.netfoundry.network" : {
      "network" : {
        "read" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:55.494731Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read Network, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
}, {
  "grantType" : "IdentityResourceAction",
  "grantId" : "c048dcf1-fee9-4378-a693-c5bfd4232111",
  "privilegeSourceId" : "c048dcf1-fee9-4378-a693-c5bfd4232111",
  "identityId" : "16f645d6-e5ec-4d27-a542-64891f58b3a8",
  "privileges" : {
    "io.netfoundry.network" : {
      "root-certificate" : {
        "delete" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:57.292210Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Delete Root Certificate, All to identity 16f645d6-e5ec-4d27-a542-64891f58b3a8"
} ]

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiIwOEZ0S2pTb3c3TkpiVEZKYUtUVk1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM3MTNiMWYxLTlhNWYtNDVlMS1iOWU0LThkNjI1Mzk3MGE1YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4OSwiZXhwIjoxNzkyNjY0NDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDRmYTNiYmMtNmZlOS00MzM2LTg3OGEtODhmNDNhNjZjODkyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QgMigPKXqp6A9WZEsdKYIXQ5kGXFKJFAntEeKH_Zm7nm3QleQlxYf7jovH6Cd9wEOisAeEBSMFWBLvyzgva14jGVteVheDS_LyIT0J5g6gu9BD23H5H0DfTc3qNGCv87uI1QgE3hZhnXvJBrg0OSn3qXwJ2iFHgeiEMcpn36bKUMu7s3Yz3N1U3F15zK2xEIYlwSaloiF2ezjMoe5AJrIZlunJrrucmbkO2Wj3wBxbiF7ansF497jMKp5Rpv8E8W1AMFoDklVFo8RfeQkCtRM-etIkjoC8mn1ZaGXCo0TIFvdTklEANrD2lDq4xOvsoLAwMy5kLdpmoy9g7wn_EoAA'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1472

[ {
  "id" : "962926e5-13cd-4531-bb10-3928b8372c2f",
  "identityId" : "70a7e250-46f8-489a-9589-8ffaeb7fa066",
  "domainId" : null,
  "createdBy" : "eaf45e9f-7419-4323-9286-7d86dfed523c",
  "createdAt" : "2026-10-22T09:21:21.792104Z",
  "updatedAt" : "2026-10-22T09:21:21.792104Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 70a7e250-46f8-489a-9589-8ffaeb7fa066"
}, {
  "id" : "df9d1287-846b-4544-934a-d0054d52d35a",
  "identityId" : "3085de67-3efe-462f-8056-fc8f46ed03b3",
  "domainId" : null,
  "createdBy" : "272b30a9-1de0-4f43-b20d-1393c8d820aa",
  "createdAt" : "2026-10-22T09:21:21.354444Z",
  "updatedAt" : "2026-10-22T09:21:21.354444Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 3085de67-3efe-462f-8056-fc8f46ed03b3"
}, {
  "id" : "53036edf-93c1-41d8-8e73-b0b83a276fb3",
  "identityId" : "5696ce09-593f-432a-ab15-0bd41755bd1a",
  "domainId" : null,
  "createdBy" : "d52aaefa-79a9-46d1-81ce-5de3ef16f62f",
  "createdAt" : "2026-10-22T09:21:17.790281Z",
  "updatedAt" : "2026-10-22T09:21:17.790281Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 5696ce09-593f-432a-ab15-0bd41755bd1a"
} ]

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/47b891bb-6578-4f8f-a082-7742218c5a97' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJPWWVzZlJVYU16dElfN3hLN2FidmR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZhNDlkNzllLWMyMmQtNDE1Yy1hNzU3LWY1MTRkYmZhYzU4MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4OSwiZXhwIjoxNzkyNjY0NDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjk3ZmQ0NTUtOGRlMC00OGY5LWIzNzYtZGY1OWM5NDRmMWNkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.UL5eGHYCk9bwLZLQsuMRL_6lVJAB0fe17An0UUQ5856hG0zWq89VUyhaso0GlvwxkbeOWXkD--owFOpUmTOZHlTrXztmSvywtZKPsYhT3wU8e-DMVyy5JMxPUQcNLzk0d8BotAoPG2KlOrThkuePPQ-hCohHOzjdo0S9xhF80qGW-qdO3ZWbpL8ocL8KfCZVCMvtutDK4mdV5ZcKanOD93zbJOP6XOJeMr6wP8wTBRGcGchpxuP70t01gSzRz39iwMyQH08XjR7AXqLUhq0UhqtJi1rR2-lU5pKH5eODmo-WhHLsv2IG2-J67ckyvFQnBVxYXdDlcT2k3ySlNK_C7w'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522

{
  "id" : "47b891bb-6578-4f8f-a082-7742218c5a97",
  "identityId" : "9d3d4fe4-2f73-4966-9cae-6879baf86d94",
  "domainId" : "d7517751-35d1-4c2c-a732-ef3c44022a0a",
  "createdBy" : "50e9b929-7af2-431a-b14e-cdd12160c2e1",
  "createdAt" : "2026-10-22T09:21:04.475445Z",
  "updatedAt" : "2026-10-22T09:21:04.475445Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in Test Domain to identity 9d3d4fe4-2f73-4966-9cae-6879baf86d94"
}

Create Super User

POST /super-users

Authorization

This endpoint requires the following actions:

  • create action on the super-user resource type

  • read action on the domain 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 read action on the annotated resource.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJ4dEFHVGRua2RVSktGQXNuWVlPOEJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE1ZGVhZWFlLTZmNjktNDRlYi04NjJhLWE0MWRiNGQ5OWUxNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4OSwiZXhwIjoxNzkyNjY0NDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2JkYWFjMWMtOTJkMS00Mzg2LWE2Y2ItNDc0NGU4ZDM1YTc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg5fSx7XCJpZFwiOlwiOWMxZDhlNDAtNzU5YS00NjczLTlhMTMtMDcyYzUxNTE5NDQ0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.onhIPcDyi_t-4h1NqfLK6QGqztBgC4-i8b4yrNJXUGKM_vg8plE2aspsDvHPr1c7LW7cJQjqTlfnpJfjLOm63VUq72pZkVLMdvtwlaKphwGVhE-IggevCH3coczumPaomPy3_gQAHsBpy9ss5EbO6zpjaVbqw2onKvj-A978OjkbvpL7O9wB18VkAsfAwqRRu79hmlztFcq5xj8R7p3rDPchpyynQDslRXJzlM_w9vFshp2zvfccplZZiEwrQLEL_293fst0yJz9qHSza9xJleeTyWj4tcZ90rTFP6nBqS2tmmf1KvkyuJaHiqrMCdLeGVBCukgTRBh-YYKPQ9kq0A' \
    -d '{"identityId":"9d3d4fe4-2f73-4966-9cae-6879baf86d94","domainId":null}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 488

{
  "id" : "a394367d-92f8-4c7a-8a3e-401cc4b77283",
  "identityId" : "9d3d4fe4-2f73-4966-9cae-6879baf86d94",
  "domainId" : null,
  "createdBy" : "15deaeae-6f69-44eb-862a-a41db4d99e16",
  "createdAt" : "2026-10-22T09:21:29.238060Z",
  "updatedAt" : "2026-10-22T09:21:29.238060Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 9d3d4fe4-2f73-4966-9cae-6879baf86d94"
}

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/2ae2b2a9-c593-4259-8155-baa6766a937a' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJYaTE5MjRFNWMwZGE3RG1FTHdocldBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY0NjNkOWUyLTQ5YTctNDM0Yy1hMjZiLWM5Nzk4ZDk0ZWYzNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4OSwiZXhwIjoxNzkyNjY0NDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWYxOTRiNzMtY2RmMC00YjViLThkMzgtNmMwZDc5OWI5OTA0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.b1lVIC8l5UgvyOVeyOtaHCy-hppiWuBQjlicy8kYU0jLC1KqUjIh9aYBnRGt3IZcHHSYFcYXLOaoJ9iZ4bWTEqK4DD9jurSSPsHks-dUJWETK_nmUK704O6VmV9OxNKH0LOkF75bAi4d6ERDCr2JRH11JlNTg9fJvNqI_UFPM9siT6jgYT0v8uAZzCiZ20Q61HW8xc7xESpyw3mXepJYEj4SGAnE1EUmWd4KRGgPX7txhoqddNfQ7O_kRJoXZyVoBDqxUW-zB-RGFIc2FGsespaa5Zld-ZhxrLQOjoAkLSuzyWMN527zhjjyJo8jdSWApatBWw2QqBMEOcRF-Se5dA'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJPLV9JSVJPbDlabVNBdHludjVxYXlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYzYWFlNzgwLTFhODAtNGZhYS1iNzExLWNjNjk4ZTQ4YmJiZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MiwiZXhwIjoxNzkyNjY0NDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2E0MzFhZmUtZWZkOC00ZTUxLTgyNzgtYTY3ODhkNGJlNTk4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZEik-QrBsWim1-gH_qZCoqaq1K9Doha1N0znVQw6vppu4PAttfLwkAcxtet2IYXtzIHgtmGnOuJhwxS0wwgLdlSCvwxoPAViHyklHlFVQGOhPBxVm2jteh6zPCtIjOwnYduJGT-KABMqFx-5MP3ib-ad7QkuHKojKkKDdPbl89J8l8ZLyJlY6tmLife3ETIVlKW5jsl1F8N34O_aKjH2eFEuSdMHSWhtcqM7VBaYPOPIDtEpoUkWuCITCOYPDmIb4M48q7zlx5tbru_P8nmpYpJg3QCp4MLezwoxjGpLbVrKTTmrWHhxPX0sAOTB__WbVN2Cf-x6H24s-uRfeybeLw'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1667

[ {
  "id" : "cf141685-811a-49b3-823d-f715b92951fb",
  "resourceActionId" : "fa38ddcb-dfec-4b21-b8c9-ba4efb586ebf",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:54.180003Z",
  "updatedAt" : "2026-10-22T09:20:54.180003Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "anonymous" : false,
  "_title" : "Grant Read Domain, All to All Authenticated Clients"
}, {
  "id" : "ac71cb6e-206b-4d4b-9371-5293757b1eae",
  "resourceActionId" : "71a68101-c430-4099-9a71-8067ce3b18fa",
  "createdBy" : "c01c4bfc-b13a-4474-b7c3-0fede0a887c0",
  "createdAt" : "2026-10-22T09:21:21.560380Z",
  "updatedAt" : "2026-10-22T09:21:21.560380Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "79ea4d37-790c-44b1-af5e-1d0104db13bc",
    "resourceTypeId" : "6b0f92fe-a812-4ac3-9e6d-aa88c25ec070"
  } ],
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "anonymous" : false,
  "_title" : "Grant Test Action 148 Test Type 147 on/under Test Type 147 79ea4d37-790c-44b1-af5e-1d0104db13bc to All Authenticated Clients"
}, {
  "id" : "8a479f3e-69a9-488a-ac79-ca2301703e1c",
  "resourceActionId" : "20e40bb3-693e-41bc-8097-ab99df6a87f2",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:56.695401Z",
  "updatedAt" : "2026-10-22T09:20:56.695401Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "anonymous" : true,
  "_title" : "Grant Read Network Version, All to All Clients (including anonymous)"
} ]

Get Public Grant

GET /public-grants/{id}

Authorization

This endpoint requires read action on the public-grant resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

resourceActionId

String

true

Must not be null.

createdBy

String

true

Must not be null.

createdAt

String

true

Must not be null.

updatedAt

String

true

Must not be null.

deletedAt

String

true

deletedBy

String

true

path

Array[Object]

true

Must not be null.

path[].resourceId

String

true

Must not be null.

path[].resourceTypeId

String

true

type

String

true

anonymous

Boolean

true

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/fcf963ce-1446-4aa2-8c32-d89e6f564b0e' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJmLUx6WDhzZTBjT2xaUWF2VmFrNnNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZiYjM4NmVkLWUxYzEtNDc5Ni1hYjlhLWI1NTBjNzZmNDU5YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MiwiZXhwIjoxNzkyNjY0NDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmM3YTc1ZjAtZGFlMC00MzA0LWEzOTEtOWZhODk1YzRkYTRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.htPUM0qPB7gBwKQsLITDUzgWJkmsWxf4Pmgw69VV5oZd46s1soUOhFNlnOQ4aEmJ1M2wev_XTG646R2yijjmI0FIHve17U_PAk0AtCC2lhGqEO9fvLoO72p6O2pbLbneelk_fysA-dh7Ng186xDZze91K6V6N3f_GoUrnh-wZP1xctGkbqgXFJBMmOhtBoXa9xzswCXu2rcSeP52D1_53Me2puLnupJJsFI5KJS7M6n5Ie3wdCdByrR1GOvmW_14Qycvh2jmzKv444d7cPST5Vq7EN3dETsbH9KYq3qRZ9Rp4ClqQ264J_Zhbb3ibR2HykDOrl4MyWsw33tRKouhIg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 681

{
  "id" : "fcf963ce-1446-4aa2-8c32-d89e6f564b0e",
  "resourceActionId" : "be986aa7-2d24-458e-afa5-21a99805523d",
  "createdBy" : "56eccded-6102-4735-9aeb-fcb370a2030d",
  "createdAt" : "2026-10-22T09:21:22.555194Z",
  "updatedAt" : "2026-10-22T09:21:22.555194Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "bbf3dc0c-53d1-42b9-a7bf-4f541eab13b2",
    "resourceTypeId" : "52d36790-2982-4203-be11-e804d62336cd"
  } ],
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "anonymous" : false,
  "_title" : "Grant Test Action 162 Test Type 161 on/under Test Type 161 bbf3dc0c-53d1-42b9-a7bf-4f541eab13b2 to All Authenticated Clients"
}

Create Public Grant

POST /public-grants

Authorization

This endpoint requires the following actions:

  • create action on the public-grant resource type

  • read action on the resource-action resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

resourceActionId

String

true

Client must have read action on the annotated resource.
Must not be null.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJpaHJhc3J3Sm9tQjBZSnRkYXN5elhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlMGU4ZmQxLTJhNjktNGNiNS04OGRhLTQzMWQwY2EwMzYxZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MiwiZXhwIjoxNzkyNjY0NDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2VhYWFmN2QtNDYyZi00ZTczLWFlNGUtNDgxNDBjM2RiMGI1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfSx7XCJpZFwiOlwiMDA4ZDBhNTAtZjJhYS00YzEwLTgxODEtODAyMGE1ZjU4ZGQxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PkdWJmG5lwGJyLvmivdj4YQuW7MNOOnfnLTQ0OU69QqzvA2Tvprwmc67q5kEf8nViKM7FKOZMXPUwctZRAzW7HhEjO4njU_fg65an-tQH1D0MMHSwoAatvK_QccggFONWvMyz1FfuUvgluFBQqvfHX-OEjI59I5UYN8F4lwkwYtaX_15q-x8oR7nsj1r_ajwoeI_2EYpPiH096gjjyoT-BXSVniAnpMIvuR8nOcAgW8bcgWN1Wax0JdwuT4JsBUFneAOJdLb5LakF6KHAsFv4D4QiGLjODRn0ilWJMlWoAfdWUAZ8gkEbLyy8p8GuCmXdd4P_vkCr0b4_U_JMFkchg' \
    -d '{"resourceActionId":"ff710ef0-f2a7-48c2-92e5-5f667921568d","path":[{"resourceId":"3b46b2c6-73ca-4664-8587-cebb2d99d877","resourceTypeId":"06d745a6-05ad-4e8a-8702-c4f7e4d99094"}],"anonymous":false}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669

{
  "id" : "428ceaf5-ddd7-4b6a-b7f2-71fef0d3d4dd",
  "resourceActionId" : "ff710ef0-f2a7-48c2-92e5-5f667921568d",
  "createdBy" : "6e0e8fd1-2a69-4cb5-88da-431d0ca0361e",
  "createdAt" : "2026-10-22T09:21:22.798304Z",
  "updatedAt" : "2026-10-22T09:21:22.798304Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "3b46b2c6-73ca-4664-8587-cebb2d99d877",
    "resourceTypeId" : "06d745a6-05ad-4e8a-8702-c4f7e4d99094"
  } ],
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "anonymous" : false,
  "_title" : "Grant Test Action Test Type on/under Test Type 3b46b2c6-73ca-4664-8587-cebb2d99d877 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/83c0929f-1944-4fdf-8c0b-78259c216f67' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiI2enc4S0phbjd0aHN2ZUtmaDV3SVlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVlOTQyYmUzLWI3ZDItNGViOS1hOWQ2LTYxNDU3ODgyNmFkMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MiwiZXhwIjoxNzkyNjY0NDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjgzYzA5MjlmLTE5NDQtNGZkZi04YzBiLTc4MjU5YzIxNmY2N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzFlZDJhMWYtMTM1OS00YWU3LTk3ZGYtZjYyMzdmMTNhZTI3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.CGi95OsL2lTCuHOcHPQjTzupr_JNGQv6Hk771eV-4WQlKxGBoB8j7PEW9bwgfRAY4xtZ599LAifxMdlNSujKIDIQLlIzz8xOsWWFElC2zt69zDP29s6XfKdtQ8zrUongT0OFIACIMQITZXS17kzggciJTJAQtgbpif2iVr7W9Myal4d-4OFqIsCYDfTu_R5XXODwH7YzHLsTvVI65WXqW2SiLHQp-hWSuRZI9d_u-1f3EpE9jyWgTn5GN9aWJEoXMKvJsHdjMBG1OB7-KucZBCs294rqvGIjwRDJgspmaRF7JiMat8e_JncEYg62S84pamX6houyT8YroWOfe9j07w'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJnRHdEQTB0c2pleWFySHQzZFBrbXZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk1ZWIxODM4LWQyZTctNDIwOS1hYWRiLTUxNWFmMjM2MWIzYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MiwiZXhwIjoxNzkyNjY0NDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWFkNGZkY2QtYjUwOC00MDhlLTkzNzUtODMyMWMzYmQ5OTZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.js0cPSqpApo1PjZjEiD6phDi6cpkZUTVGPVNYJZv3Npj0cS6Uvz1alO4YAfP4m9VaI_24xUtLQ95mXqgbVIfrZyUd2JNIG5gF6Bnk2Y412N2VZJ9t3qP-HXrKcUPLU2jfED-9r1wrjX49jxv5ZU65PFsrFOU0etZpfd9CB0UlvQhYC4toZDkEwvUb2bUM4BG87Mz0wIrN74Q3AgVrYfESl6jwSQliUzFWyHBm7GpxWjny6HOGfsrVzyZqbuMz5F4W9p00EnvFq2pAwgVnGsNtE1DLAYEnNQk8OCtqMgX-LjdPcMxH_gNFnqg9iwYmC5BGaILDTSFTsaOjbmlkSlHFw'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1705

[ {
  "id" : "5aa3b9a3-f41e-4b79-83f4-252787e0b041",
  "identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "resourceActionId" : "353592df-bdbe-4bff-ba5f-2270a49d8248",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:57.347457Z",
  "updatedAt" : "2026-10-22T09:20:57.347457Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Update Standard Role, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
}, {
  "id" : "e6ed9a9a-26b2-4ad8-b91c-83ce8dc1d94b",
  "identityId" : "fa06a740-21f8-480a-9e7a-1f759b506e0b",
  "resourceActionId" : "fe64124e-2b58-4035-bf13-1ed70be41c3f",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:55.182821Z",
  "updatedAt" : "2026-10-22T09:20:55.182821Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Read Network Group, All to identity fa06a740-21f8-480a-9e7a-1f759b506e0b"
}, {
  "id" : "5ef313c3-d744-4ea0-98b6-ae00d7dc986d",
  "identityId" : "1a8bab6b-a4ab-4a92-89e9-09b4399a10c1",
  "resourceActionId" : "88c30308-b5fe-406e-b105-03a0a80facfa",
  "createdBy" : "aaab95aa-7da9-4a1c-940b-a61eb4259f89",
  "createdAt" : "2026-10-22T09:21:16.737245Z",
  "updatedAt" : "2026-10-22T09:21:16.737245Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Read Action Inclusion, All to identity 1a8bab6b-a4ab-4a92-89e9-09b4399a10c1"
} ]

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/c710b26c-e7a0-46cd-a0bc-2158baf43190' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJ3U3J3VTNMWE9KSnc4ZGpVQ1B3em1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdlMzlkY2MwLTU1N2YtNDBhMS04MmNmLTcwODJmN2ZkYWZiNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MiwiZXhwIjoxNzkyNjY0NDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjRlN2JiMmUtY2M0NS00NzZlLWI4ZGQtNTRjMjg2MDYxNDViXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jlF6vSSZFnqrf_vqQ9DqcuUbNVwph9IFGMLJl-jtE4mg6f6sgZ1uVuWlTkLoVkt7z-eC53JcKKfe86P8fGCM5Gm8cD50qq2DJeE57zHPAMY2cwolAavgKcU1LXiF-MMrGT2DwJRc4pZUYZhHtQ7chwVRt1WjILv4zfhRMhvHbsCYLHdag-OCCwPASVEbT1oWYYHxDDG1W6fzyDVIKF7e2Pzmi-qtX3soxpIQ3IhAJIigH_U7XhkB6BVw3AhN4VxFjF7pfjouDV-7HxHJgFH3kPUT3lBUbsG4cNRgFS2wkXXjyr8WO8hAuuiwa0RQ3HSPa3GdmnTTPemSz70-EbUTIQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 757

{
  "id" : "c710b26c-e7a0-46cd-a0bc-2158baf43190",
  "identityId" : "6e317dce-6b84-4c0c-a5c3-f346a7bbe012",
  "resourceActionId" : "12a15ddc-30c4-4c7d-bc5c-c83428084567",
  "createdBy" : "ad9c41e2-fcb4-4c73-9347-64df26d1961b",
  "createdAt" : "2026-10-22T09:21:22.302168Z",
  "updatedAt" : "2026-10-22T09:21:22.302168Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "b3e7ee6c-62e4-4e67-a764-7d3d5b2164af",
    "resourceTypeId" : "260b70b7-3ce1-4492-b1d2-96e9a774718e"
  } ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Test Action 159 Test Type 158 on/under Test Type 158 b3e7ee6c-62e4-4e67-a764-7d3d5b2164af to identity 6e317dce-6b84-4c0c-a5c3-f346a7bbe012"
}

Create Identity Resource Action

POST /identity-resource-actions

Authorization

This endpoint requires the following actions:

  • create action on the identity-resource-action resource type

  • read action on the resource-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 read action on the annotated resource.
Must not be null.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiI2Zms1b29DMVhqUGlGX2ZzWEQtd2VRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU2OGU5NjJjLWZkMTgtNDNlNy1iOGI2LWY3MTA3OGUxMGFjYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MiwiZXhwIjoxNzkyNjY0NDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTFlN2FmNDItZjA0MS00MTk4LTkwMDAtOWYwZjVhZTU2MmViXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfSx7XCJpZFwiOlwiYWIzZDBhN2UtZWE0My00ZjcyLWJkZTQtYzBlNDU4NDE5ZDBjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.o3zOgKyMlbZuv3UQkwEOV5LkxeNjsQoEvKMQ3gGOL6bLMnzNgX3ImgqGTHDJdzJVhUYjF4G18zGZJ6V7sN8yckLm0ojnYyPF-upLGZlGw2wjpcKYFlaVHaavaCDUTihdKKD_nLlwRGP9SFvhIOBus3f6BNxorAbAUxW1uex5FZuzBnQmcGWzAXW8gDZdN-3YInlsAa3pYjqT-lpmhcGGzTc0yeMw-6nfyXZITH949ZjN8izvbq4sA0I8dv-fi4YF_8vIgUnRf4xbMtfGu6LjwMwbjp0wFPZYsOKMj2UM0oJ1V4XhzIwhmqkv-aooQpGdSknaQla8wmjTjsDLv62m9Q' \
    -d '{"identityId":"b7bd8cba-81a8-4b77-9b06-db307d9eab7b","resourceActionId":"ff710ef0-f2a7-48c2-92e5-5f667921568d","path":[{"resourceId":"7bbfdb2b-007f-4995-97ad-0bb975abc088","resourceTypeId":"06d745a6-05ad-4e8a-8702-c4f7e4d99094"}]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 745

{
  "id" : "5e1fe3b1-3d31-4e03-9043-3ea0f488623f",
  "identityId" : "b7bd8cba-81a8-4b77-9b06-db307d9eab7b",
  "resourceActionId" : "ff710ef0-f2a7-48c2-92e5-5f667921568d",
  "createdBy" : "e68e962c-fd18-43e7-b8b6-f71078e10acb",
  "createdAt" : "2026-10-22T09:21:22.467743Z",
  "updatedAt" : "2026-10-22T09:21:22.467743Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "7bbfdb2b-007f-4995-97ad-0bb975abc088",
    "resourceTypeId" : "06d745a6-05ad-4e8a-8702-c4f7e4d99094"
  } ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Test Action Test Type on/under Test Type 7bbfdb2b-007f-4995-97ad-0bb975abc088 to identity b7bd8cba-81a8-4b77-9b06-db307d9eab7b"
}

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/62d964d1-47eb-4af3-8a49-3578bd114a4d' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJzN2dqejlzSC1ObHVFaFhIRzJYbTZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk0NTRlYzlhLWI1MmUtNGNhZC05NjgwLWRmMmRjZDEzMmU5NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MSwiZXhwIjoxNzkyNjY0NDgxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTAzOTI2MmYtZGM0OC00OWRkLWJkYTAtZTY5YTc5MmUxYzM4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.HhVJrszF9Vd8VEtXV2X0i0-M2Fiinu9_xdlwvJrj0uwmnzjK-kFF3pcm5FxMk8RlulQe643eocJCK6AW3aIEaEZUpN5rJiiaEYkhV6iVkJGW6Zw3qPdWmoVesNiVUPeYDqZrdO-ZFsbk9pfXE3DCcS-aPrRs8yuaUiYB1GcYS9XR7HD3eVnu23ToWIqJFLO6wrvMFkth-6vF9Iclv0aCcLHv6GWoTF-nK68bW4JrgKeoL0G3n-ngptfpVQD6PDFbCNTzBOxyeHNhdoFQV2YmYHGjXFcesvfoKdMh0AQrnIrxF5nrtohK0PrP6IRtYBGqNm1nF5x0FRGJCcbDfWsplg'

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.
Size must be between 1 and 256 inclusive.

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiI1bjZMa1RPMXh6b2Z4T1kzTDRsRVpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAyYWY1YzRhLTMyMjctNDVhZS05ODcwLWNjNjMwYTYyMWY2ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OSwiZXhwIjoxNzkyNjY0NDc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTgwZTNmMDktYWM2NS00ZDA5LWFlYWItMGRhYmFhMGU0YzRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GyuzWwRVQY1gspLISJu3NndprM2vHVFpN6-mr-I9f2hc00NOouCVI7HRhwLlv75I9D2i1p6vJUP80otC12HnjLu6nhxJl3Nwjti-_tLNL__5GcU9Bq7GL2iYqM-y6KIVJ6zz49wZpAexr-2bvmQzpf7S-i_TyYA0G2Q2zt7W_7dLutVq8PGY5DKKsOchlw-CUU9Y0SWtZMZZdIvfOXWPMflnKIQzxGtqrLpPGwjULKufud-45CJUvPB8ezO7kImylvHlges2u1wmMBdYvHgvyNlEwWGxItr2nAQcJlKwO95dO4LuLDeD0DvTCg74R_29EiTJawbTg7uzbpvGlhZcZw'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1161

[ {
  "id" : "80341cac-4c80-4183-a66e-8bbcff2cea81",
  "name" : "Onboard Trial Customers",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:58.409429Z",
  "updatedAt" : "2026-10-22T09:20:58.409429Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "Onboard Trial Customers"
}, {
  "id" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
  "name" : "NF Support (Read-Only)",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:54.437703Z",
  "updatedAt" : "2026-10-22T09:20:54.437703Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "NF Support (Read-Only)"
}, {
  "id" : "5b7128cd-b6eb-469b-aa5c-a831e6612e11",
  "name" : "Test Custom Role 126",
  "createdBy" : "418836de-04e0-4077-b03e-db69dab3456e",
  "createdAt" : "2026-10-22T09:21:18.748420Z",
  "updatedAt" : "2026-10-22T09:21:18.748420Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "Test Custom Role 126"
} ]

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.
Size must be between 1 and 256 inclusive.

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/5e0654a5-3f03-4687-a542-545b81ae7ee5' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJEN2pkZHlvcFE3UmZQem5CYUh2MU9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMyNzc1ODIyLTY1N2UtNDM4My04ZDZiLTM0Yjc5NTI3OGFkMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OCwiZXhwIjoxNzkyNjY0NDc4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWQ0NWRmODktNDQxNC00MmU0LTkyMmQtZmU0OTFjNDBmYTJkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PuwIgW9FLtzc8QVQDweMCKEMgC_wUL1VhnNI-_i_mAenQ4hlzZI8x-Jlld2PvSg4xRxU2MB2zoWtEMnAKl8T6m-2xCja60NMPCaTvIHktcIuiulvzZeqazHdwtrWCFFS07PaOjeUy5hfYGmG1b1sBgSFhjxA39q5aaIs7Bg2ziHUv30rVBSvxebuoQ25TvszQdvMdbh_eIc0tu8d2fQ4KStNd4le6VOI7EG_ANQq_1pdLjWBZU4FO7gqy7NEB4wSA0R_73YN_YQJkg3MJDRBGPS9yNlqZFgZHMqan_3UhLiZtZr3ZIi0RToODJx8In7TyvH2CG590IRnDWPJtev4FQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 381

{
  "id" : "5e0654a5-3f03-4687-a542-545b81ae7ee5",
  "name" : "Test Custom Role 130",
  "createdBy" : "85448e6d-ee8d-4b62-b530-aa00ad6309f2",
  "createdAt" : "2026-10-22T09:21:18.847215Z",
  "updatedAt" : "2026-10-22T09:21:18.847215Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "Test Custom Role 130"
}

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.
Size must be between 1 and 256 inclusive.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

name

String

true

Must not be null.
Size must be between 1 and 256 inclusive.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJIVkM0YWJyTUt6NXprZ3IxN1dXUVFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY2MzkxOTM2LTcxYmYtNGEzYy1iOTFmLThiYjliOTEzYzZiNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OSwiZXhwIjoxNzkyNjY0NDc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTVmMDFmMzQtMTA4NC00NGE1LWIzZmQtN2I5NzZjZmFmMmY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GHAGyG6Lrv6Qn0xlXJhA36fEO02KuRvND9X1Fm_a751r_50R0_Bu8z5tizcDF8ICIJkbtqUeCBTytCB2NKfpRbJEMbB-nhBA4u64ax3SAqbhmII6A8jj8CLwOB2eMU-B0AA8KGctKP9gw088QESO4kcE6lOO4F0ZNLdYfq-Ukvvk-TKxgNscLy3i4WteSvOIQ7SBN2hE3esuosJMZDDOt2A_zV1avZupj6nFDsYOr0BOFC07qTRgrokNp5FUL8uhMBtmEbfYHcC3EuZ_4kxmG-YTNUed8vvjKRQhquuhiPehJQjufnFf_Wxk2O5m-HfqwYILgAJsQyUI83q19NBT7w' \
    -d '{"name":"Test Custom Role Create"}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 387

{
  "id" : "c62041ca-8574-42a3-b6db-2579fd9e8612",
  "name" : "Test Custom Role Create",
  "createdBy" : "66391936-71bf-4a3c-b91f-8bb9b913c6b4",
  "createdAt" : "2026-10-22T09:21:19.576808Z",
  "updatedAt" : "2026-10-22T09:21:19.576808Z",
  "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/aa736298-27b6-4c1d-bc52-8b8fd4e7eb81' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJOWV9KSmhZbG5aRWNZSEhaaHg5OWZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMzZDc4M2IyLWJhZTgtNDc3Mi1hZjZiLTIyNjY5ZDk1NTA1OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OSwiZXhwIjoxNzkyNjY0NDc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjgyMzUwOTAtNzg0Ny00NjZhLWFkYzItMDE3NjdlNTAyZjk1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.cJG4tuIZNkz0gx-X-swj_QT5EyVc3a-8rZQ_DNWkz3Ts97w7CHd5K4vuOWSNupa7xtKVtkm79h-ctYJ7mcDBzMyJ27swHqjmbfB7LdPRMpq2_5G4g34IrJqvdZbls713rUX-fhUETo8swGgGfkI5bh9IUWANtVi6f9bdP5J3z0rYO4b0-6nTar0l6UwWusWQt6JnVJ5vwz0CBqUxTfcTLnE42Ks1ihYgRvSNfFx8WoQ8MLJlE1JPSS6iEjP0mUfxJqmby3FmpALbmqDlLKGErNz7JWptUw8g-mWY2XWqvRDZwqXGTW2Zf6DIdeOOLO8gJiI6IEIamHz2LYAdWN246g'

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 the custom-role resource type

  • create action on the custom-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/be4e7c2a-6603-4f9d-9e45-8d2795b23683/identity-grants/1fc960b0-16db-4d51-a617-36167139d12c' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJoeGU3cEFEb2VHSEhtRnNoanZYSFh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFmNWQ1YzczLWIyY2ItNGI5ZC04ODZjLTI5MDE2MTg3ZDE1ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OSwiZXhwIjoxNzkyNjY0NDc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjJjZWY3MjctZjk2NS00M2VmLTkwOGUtOTUzZmU0NWM0M2Y2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc5fSx7XCJpZFwiOlwiYWM3OTVlZjMtZGM3Ni00ZjBjLTljZDMtZTM5YmRiYTI0NTM3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.VMTI74Ev8ZraV2_c6sRzWX0PLm_QC4asmJg4VtNHtns7eosc77WmDaKHD27qlcO9awTbWE3EQ8yFmdwigEQ-4pmD9QdUgMqsyX6Pn7IU-LQiwtoIWCV17iSjzkkOVau-qPxZNPxMjPJz5vf9cV2jj9oRzrGhAlU4sS2h5rTuJivBh7CnhS11s_pj1PtjW2ryDJAZSPEbEHHTc74CJeO6ZRag-H0YcACFr9Nsem9Q3Ji8ROjBfl0L-ox77LvJIk63IY4hWVU_LnG6FycFiNZRHkyU1I0N2kyEhXVnehTKL1lHBxWkHvxy3ycvxvKdycu-j8ZUcLYAFy-cUUcW4wFs-Q'

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 the custom-role resource type

  • delete action on the custom-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/345c837e-e2e1-43db-8042-406f8cbcc52d/identity-grants/0877870e-fbc3-4360-ae56-e1205456eec2' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJZTGY3eC0wU3loWGJOMFFJNzFsQXJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA4YTFjZTg1LWU4YTAtNDk0NC05ZTZmLWQyMGRlN2ViOTUxYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OSwiZXhwIjoxNzkyNjY0NDc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTcxZDMwOGQtOTY5My00ZTQ4LWI3NjYtZDhiNWRmZDk5YmQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc5fSx7XCJpZFwiOlwiZTc2MjVjMjAtN2I4Yy00NmMyLWE3NTMtYWE5ZmZhNjdiODU5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Ev1RuCT2F7NOKNX7iBlxN6jwlVejfkEoISgrThlBDQIM63MffVLMMvhlkvKzblnuXDW3F6VFnn0tNNrS4KTG0BFX09mYeUUJ3iibrX74KaXo2vO_W3KhAAim-PEJAnQEFMcv1giRwcvI0wzQ8z46IFbSWB8MQ0N1Cz968MY6nRUj2qkwwQkK9xs1ZbfcASG3teXKkFjesDwicflcGigLHL-tEi0BP55Q6AJXbDn6a9_jjd34Pp1Zqa7wajKHerrSwHh0bw1urLZQCWFF47ztEMysj7JDdB9BlzZJz8FIzlFPxQPtEGuBQiuaXkhQBRNdlpvXweJ7L-3L30Kj-fvp4Q'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJJYmplNUZsT0RqaGVlQUQwVS1BR2t3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE0NTNjZGQ1LWFlYjctNGRlMy04M2MzLTQyMGE0MWJlM2QwMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OCwiZXhwIjoxNzkyNjY0NDc4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTNkMTZmZmQtNzIyYy00YjAyLWJjZTgtZDgwN2MxZmM0NzY5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.UQlqL0quIojdf3tKe6n00c2Yzq9jIwOP0dtNWsJkdI0oINSzOIaX_rkwNELb0c8XpAOJr6xfijp3JYmc-oRJ8ZQUrIaohaq91wFb7VdkxooWEdnmU5jDXWKFA03jTXq0zOctcVJh-t-D7B7_Io8ukPpfT9QEKmN-Heb5h8prHmm8g1PRbigBr8Rz6qx2nnRyOIK4utFIIXPaABl4Dm_pnAAhxLbtJyIurrMq9b9RuO2W08l_Syj4y-s3uJEN7iW3B9oWbw5BkOBvcTp-yQDt62GkOkPR3huoQ0V1JoP9xa6rD3F_4-RxkMSwjiYKnd_fK-oWmXZDkihzZ0iCXuhKOw'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1292

[ {
  "id" : "8e7429bb-9461-4d47-9f89-135da8d8b9ec",
  "customRoleId" : "74a9a6c3-106c-40bc-acab-780c837ad8d0",
  "resourceActionId" : "0e71e0cb-99a8-49d9-92bf-b7ca790e89f8",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:54.604107Z",
  "updatedAt" : "2026-10-22T09:20:54.604107Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Read Custom Role Grant, All"
}, {
  "id" : "54f620a7-a429-4f3a-82a8-70c41e355dd4",
  "customRoleId" : "668720a0-531a-44fc-b196-4d3dbfba73eb",
  "resourceActionId" : "68c30417-bde3-4d1a-aa6c-5889917f548e",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:56.390031Z",
  "updatedAt" : "2026-10-22T09:20:56.390031Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Read Enterprise Subscription, All"
}, {
  "id" : "19fe62c8-cc70-4ff8-a837-158f4394bb45",
  "customRoleId" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
  "resourceActionId" : "d202da42-c21a-414f-8853-ef919d7cc422",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:56.922932Z",
  "updatedAt" : "2026-10-22T09:20:56.922932Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Read JWT Connection, 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/036fb486-94c7-4fa9-9202-78c681ce749b' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJMajV5Q29mMVVjeFUtbUdKcjlNYVdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAyYmRlYjEzLTMyY2YtNGIyYi1iNTU5LTQxOGUyMjcwY2I3MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OCwiZXhwIjoxNzkyNjY0NDc4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWI0NGQ3MTUtYzkzMS00Y2QyLWI0ZDQtYWY4NTUzZWM3NmE2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.KZ5SkMV63kYDNvEX8qkyMosqPNlcyKXow8JMvoobqxy66NNk4__7EbHNvfMy4ZQHEWrdZkCHIct_-WekPVSmSMhpLBO2na3Pcug9GT_mMqOvKRvUfAmKoRdFA_2pg_OuOQUOYxVn8vonGkS7piWiVV4rOAn3wePgm4oEPtDg7YeR6pJykI-nTj1puXnPlo31hr-nzAz79A-a2NEjfcmH4WQvgxL1_q3lM_aF52y2G7T-orc8bBDVkNVkdRMOASpx8JfmEKNplLY1ZSyoKtkPw35v7bpOrOkFMtcEAPw7jomCPtEoeFGStD2oF7gc-JuMs-cyAAOwpmpfFQz_vLpaUg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 616

{
  "id" : "036fb486-94c7-4fa9-9202-78c681ce749b",
  "customRoleId" : "928e5340-3a60-4aea-9b23-0a8008bd9f35",
  "resourceActionId" : "716597d5-4771-4e55-aaa0-3f266bcec12e",
  "createdBy" : "bdce425a-4164-4134-aa05-829de8621001",
  "createdAt" : "2026-10-22T09:21:18.542902Z",
  "updatedAt" : "2026-10-22T09:21:18.542902Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "016976e8-993f-410e-9f09-31a6862ae03c",
    "resourceTypeId" : "49b23dee-9fa3-449f-9115-8de31adb05d9"
  } ],
  "_title" : "Test Action 125 Test Type 124 on/under Test Type 124 016976e8-993f-410e-9f09-31a6862ae03c"
}

Create Custom Role Action

POST /custom-role-actions

Authorization

This endpoint requires the following actions:

  • create action on the custom-role-action resource type

  • read action on the custom-role resource type

  • read action on the resource-action resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

customRoleId

String

true

Client must have create action under the annotated resource.
Client must have read action on the annotated resource.
Must not be null.

resourceActionId

String

true

Client must have read action on the annotated resource.
Must not be null.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJSNTRQM1M4d1piVldwaHBoZVQ5WjZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI2MWM4NmZiLWNiNDItNGMzYy04YzZhLTNlYjQzN2E5NzI5OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OCwiZXhwIjoxNzkyNjY0NDc4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODA5YmJkMDEtNTk2Zi00Y2ExLWE2ZjQtYTEyNzFmNWU0MzFmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc4fSx7XCJpZFwiOlwiMzhlZTVkZTAtNTU4ZS00ZThiLWE4YmMtYTRkYjQwM2I4YzllXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc4fSx7XCJpZFwiOlwiMTQyMjM5NjgtOGQyYy00ZGNmLThjYjgtYjg2ZTBkYmU1N2E0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EfxQm807cB4Z19C3Cnfoltu1F-by1Nz5oNokyJ1q6Kr08QtwzAX9Uf-2ty0w91OH8WZF-emSPOejHOyjU9gUZPc7PDevcYtEFEC3JbEIMzqJ8AtM1gc7yl5CHBxHly9-IKbNU_WGPPwlkhVdvVMqLzp5nI3QYwOuC-Xk5qaVDBWkAH9p8zW32oBGqFJOa69BLxyZYxwXR2t2uy5p4vkYkqQeCD52z6b6XoLic1CeSNNo4m5NPpVX3acD-_w9t9Zd3z4cWQNdE3gYev239SZljOqlVZKKjfp6f8xJuyQFnOv4QMZLowiO6a4yMGbNqyofGwgAystPt25lAb8U_7xW3w' \
    -d '{"customRoleId":"4cbd5144-152a-4c3d-b2d1-29a50edfc0b7","resourceActionId":"ff710ef0-f2a7-48c2-92e5-5f667921568d","path":[{"resourceId":"eb6d1791-4c0c-467c-9f30-5a51ed5e7838","resourceTypeId":"06d745a6-05ad-4e8a-8702-c4f7e4d99094"}]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 604

{
  "id" : "cdc1e0a2-c3fe-48c3-a306-2fedc0b5577f",
  "customRoleId" : "4cbd5144-152a-4c3d-b2d1-29a50edfc0b7",
  "resourceActionId" : "ff710ef0-f2a7-48c2-92e5-5f667921568d",
  "createdBy" : "261c86fb-cb42-4c3c-8c6a-3eb437a97298",
  "createdAt" : "2026-10-22T09:21:18.400377Z",
  "updatedAt" : "2026-10-22T09:21:18.400377Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "eb6d1791-4c0c-467c-9f30-5a51ed5e7838",
    "resourceTypeId" : "06d745a6-05ad-4e8a-8702-c4f7e4d99094"
  } ],
  "_title" : "Test Action Test Type on/under Test Type eb6d1791-4c0c-467c-9f30-5a51ed5e7838"
}

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/ca96ed6e-02f9-4b54-a6f2-8fdc510f2b0c' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJFUGNWRjl0cXFKbmM1ZDhhYTlzUFJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFkMWUwNmUwLWM0NzktNGQ3Zi05ZjI4LTY3Y2ExYTY1MWI2MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OCwiZXhwIjoxNzkyNjY0NDc4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2M5Yzk0Y2MtZjJkMC00N2M4LWJmNjQtNTJmOTBjMTA2MGUwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.kq2zfzBzPkFo-c6KQnk6dZNl7ydgmwVmFArzzgbFBu_ywjdkFSxoJ9jbqusTtO4qzAahk9vj92N0WxgoJaWUFG8L19IrGQ0c5Q3t_Nl98msFKN-8i4auQzQoQolF5phxBbYtW38HC4Nk3_PdWjlm1z0u7ikRFVVIz4iU2-qdSJtHtM2wrv2UMPTGikkXtOZHMgtG39JcrvOe-WCP2YNSRz_0s_S_DAnsieehBseUPJIxtco0n1EGrOiMBcSmF46Rvp2npzKK5lDYmiC4Yxo10m7REKOTnUsET41LQE0WbLmTFAMPZzHkaSPR5lntHOoopC08P5RHCMjbGTMD9wP9MA'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJUTnVGWTNyUTlHV0oyTGdYZTVWYUFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM1YWE0OWNiLTIzZjctNGZjOC1iOThlLWNlZThmYTlhODk4MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MCwiZXhwIjoxNzkyNjY0NDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTAwYzg1NzQtMjFiMC00MTIwLTkzODctYjZmN2VjOGJlMGZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.c1FXp99xegF18eQfrieNQQHyOrugd13PkiMitm08CviQHcabx7_haLPQ14dxUELBPO7lsk1mFECF8Y6RDbdFcKM2_FSyQrt8dz8HZgmyjMwD7UOfGfWxltYEKZCQiIdyijk-lLWRmzs-xUOMhEmiNCSCxOJXT723-_LnZ_1XuOJoyz7PG2gLQsyzHruThfKxjyin1v7LEctGpHNlaSmbeZkvProqQkpMjBr1B6G-QWviCVmmBcKvomlFozL7dPgbwDnfnpaObtnzA0NHJOyeFpEh77BP2pvDXnThebbQbnaxwH8czZYfyxMoShiTqc5-suPlvcAwWnGYhP9okSB_hw'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1401

[ {
  "id" : "3e16674d-9da6-446b-aca4-a628fd9173b5",
  "identityId" : "14b42c56-d3ab-11ed-afa1-0242ac120002",
  "customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:57.253694Z",
  "updatedAt" : "2026-10-22T09:20:57.253694Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 14b42c56-d3ab-11ed-afa1-0242ac120002"
}, {
  "id" : "e52438e8-3d19-47a1-acf7-2522f76e7903",
  "identityId" : "4b0c906f-2915-4786-a783-66ec832c1e9b",
  "customRoleId" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:56.589782Z",
  "updatedAt" : "2026-10-22T09:20:56.589782Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant NF Support (Read-Only) to identity 4b0c906f-2915-4786-a783-66ec832c1e9b"
}, {
  "id" : "27b3f08e-05e1-4697-bb76-73e91df6211c",
  "identityId" : "81fc711b-d0dd-419d-9280-5d095958c76a",
  "customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:57.513809Z",
  "updatedAt" : "2026-10-22T09:20:57.513809Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 81fc711b-d0dd-419d-9280-5d095958c76a"
} ]

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/af61a11d-6360-40a8-ade4-f6fd9c85428f' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJlMTdiU0NlbndqMjhnaXJrWWZYcGVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE2MjM1ZWQwLTNjODQtNDM2Mi04N2Q3LTgyMjhiZGVlZDFhMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3OSwiZXhwIjoxNzkyNjY0NDc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGNlOTY1MTMtMDRjNC00OGYxLWI3ZjItMGRmNTZlOTk5ZjU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fgBhGlu4kEIeFdCTwEGBB3znD6oh2Ls6Lwl01vNI-7WM3Tk5IAMiaK9AISSNg7IU1CCb6CBrnYrkrGwQxnbPJTDn3f7Wx_fAiq59Er1Fk4ckP4Y88N3_4ny9xkrElK88REG8DPKiuyQk2kZ7hFIdNf54BNnmvRmu6ZLp499dzgZQ9eFKsZnKJChT6xyIJr2VLiHvai4IAks768srj0CFHycTBQJkyksutx6br5vJhKK6TVgRUUJ7BKfy7ZJc8_WBuJfCiJD3Nv4agP4XZD-isn1brZx0n_oP7NUIvop5cDklbLGdVdV9uS6BDIZo1s7uLOWap-IrcwAo8KdnO7A8zg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 453

{
  "id" : "af61a11d-6360-40a8-ade4-f6fd9c85428f",
  "identityId" : "1e124203-bec7-47a1-b30b-655d86667c60",
  "customRoleId" : "df72dfa3-a878-4b9b-aafc-1506b279baee",
  "createdBy" : "41334a53-3cce-4c13-bbe5-d436c90300b0",
  "createdAt" : "2026-10-22T09:21:19.896925Z",
  "updatedAt" : "2026-10-22T09:21:19.896925Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Custom Role 139 to identity 1e124203-bec7-47a1-b30b-655d86667c60"
}

Create Custom Role Grant

POST /custom-role-grants

Authorization

This endpoint requires the following actions:

  • create action on the custom-role-grant resource type

  • read action on the custom-role resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

customRoleId

String

true

Client must have create action under the annotated resource.
Client must have read action on the annotated resource.
Must not be null.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJaczJ5QnN6bmpISEFrRFNHbHQtQ253IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlZjhhYTAwLTAxMTktNDFlYS1hMjg3LTc1NTM5YzhmMDljNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MCwiZXhwIjoxNzkyNjY0NDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTBjOWRhNjktOGMyOS00YzBmLThjMTktNmM0NTIzYTgyNjlkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgwfSx7XCJpZFwiOlwiMWQ1MmMzNjctZjNiZS00MmRkLThiMDgtZTA0MzNhZWE1OWFmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.osFbCZucmcqopsclpleeU8jvD_CEUStQsff3nKnwdAOKRv0VA1NeQfCKT7fpx6cLKxCRG9dAM8OYa1VcGDp7FQqkBV9j-NdLKW51-JU0Nk3v0H4ToLyLjM1TWjpvvQhI8_nd9PkoJVz5R9L7Q6XUKwWtZpwlvHeR0a-pCM9kOyt22sIvyZYS8fk3Ph5aG2O3pfaTFKNMQ82vyJSgLt7SjYTD-5hVjuX4pQ8nZQKMtT5NWrBL9Z3Ik8T6xD1k7_-Klcz83RFTi6SOO09tlKaVAkkF9PJpmmh_yB8VTz8BWzWogmMm2I8L9WKjCmUNeAJvlqWfZ1xan2dW23glfwOdvg' \
    -d '{"customRoleId":"89379265-c537-4047-b995-bc6bd9e70336","identityId":"ee56173a-5ebd-4e99-86f8-72a3329ae843"}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 453

{
  "id" : "ba7fd547-3f01-4a8e-9aa1-f95d13d59914",
  "identityId" : "ee56173a-5ebd-4e99-86f8-72a3329ae843",
  "customRoleId" : "89379265-c537-4047-b995-bc6bd9e70336",
  "createdBy" : "6ef8aa00-0119-41ea-a287-75539c8f09c5",
  "createdAt" : "2026-10-22T09:21:20.205385Z",
  "updatedAt" : "2026-10-22T09:21:20.205385Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Custom Role 141 to identity ee56173a-5ebd-4e99-86f8-72a3329ae843"
}

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/dbbf34d9-5895-499e-b200-919e959de783' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJkeU00Y2d1My1VV0xHY0FxeENHd1BBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUyYzIxNGI0LWNkNzQtNGJhNS05MGU2LWIzZGJjM2JlYzVhNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MCwiZXhwIjoxNzkyNjY0NDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGU1M2M4NzUtMGU0NS00MGQxLWJjYzUtYzVkYWJjOWFkMDk5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fuMimnOce9tldlyD8eOOUJSoOrVd9ZWQNJHxMx77p4stUBTXOp_Uups_WR3xEYL6BIaXOAT6j2v8TmIzD8p1ZPUPFJtm1W_N23af1-Ad-FFUmBgC8SMJ__apo09J3TUh0ZfsU1M1M---a3YRU9InNo9ah1shb1rSaHC4KSYVaj44CDe_DRHntzydIJpaAZRTzt5GHH5rBdIvKt5dLpkAO2y19BryUNQXy2DdNv9ABElUaHv1T5JpIL9SzHG0gUtVN2nx6EaueZQHekoKlbUMYi8bmGVzHfSL3mwWBtQxgap-wMfZe3QUps9ToTOYuMiJjByJq9gqvWEPb0EMbt4UCg'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiI1OWlmVm0tcTZWaGoyVmxXQ1JON0dBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVmMDVjYWRmLWY0ZWUtNDRiZi1iMTU1LTIyODNmMWI5MzUyOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NywiZXhwIjoxNzkyNjY0NDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzAzMThiZjgtMjIxNS00OGJhLTk2ZTgtZDkxMmExNGE0NTZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Ek_oMrJdbyOz4ARY9Ij81Foo5KT0UrBFY-bLpmjSx-wWlSVUDFYSzoU2JxQwQ4a03S_o1Zk64UlgPkosXLFMtcSY4cT1ba1mx6Qb6W-O-M5J7chR3pd-dbjc6-BW4WYvetNQHulZ86WCUWINUOYa_nYqmWNYDknhUCH-jo2P6EXI31uy7beEwxCFd9RXuFcJP1BBa2ivfN5Jh_HWuDe_XDRuYLYnux8nM4WfXxUfQn7XKIHkpmqS8aGiVHx7nhe85XLe0Lee-l9lnsYmBgYYEI8eyrmuPgFiNR5RwdDIyJk_ru7o5lE8FFS8A5pWMdvvkaAhSVGOs4l31ZgwltSMxw'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2050

[ {
  "id" : "b75be358-a3f9-40a5-972d-a804c4758041",
  "standardRoleTypeId" : "de36ae17-7e9b-4759-b862-f9467f099aba",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:57.656955Z",
  "updatedAt" : "2026-10-22T09:20:57.656955Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "bce07cd1-8f36-44a3-b279-26426e7a53ef",
    "resourceTypeId" : "fe2c3913-5f30-4bb1-9a36-a99405e27e55"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Network Group Admin - bce07cd1-8f36-44a3-b279-26426e7a53ef"
}, {
  "id" : "9b1489af-8814-42f5-8c4b-cd6002a56b79",
  "standardRoleTypeId" : "1b9f8cdb-b05f-4d5d-a58e-91a851c3b71c",
  "createdBy" : "7505dffa-9c66-42a5-ae34-24318a2b52e3",
  "createdAt" : "2026-10-22T09:21:10.582892Z",
  "updatedAt" : "2026-10-22T09:21:10.582892Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "a6fb0a34-8a84-4e7d-a313-1371b7414ee6",
    "resourceTypeId" : "ba2daff9-e867-4398-8216-5a338782788e"
  }, {
    "resourceId" : "b8c76548-9cc1-4a1e-95f2-926573fd0e9f",
    "resourceTypeId" : "35f37ec3-589f-414b-80db-2c83b702de1b"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Customer 49 Member - b8c76548-9cc1-4a1e-95f2-926573fd0e9f"
}, {
  "id" : "ac49703b-b452-43a5-beea-051795a83c9a",
  "standardRoleTypeId" : "7da912ef-1d41-4158-9acc-bc6bfadf4658",
  "createdBy" : "b6162c6d-24f9-4865-b901-70be560be030",
  "createdAt" : "2026-10-22T09:21:09.602777Z",
  "updatedAt" : "2026-10-22T09:21:09.602777Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "1f627130-bf17-4875-a987-08c10f94bd60",
    "resourceTypeId" : "f4250257-9f24-45e1-b346-2a3703140adf"
  }, {
    "resourceId" : "e9d457c6-e44f-4fc9-916b-9c01a362083c",
    "resourceTypeId" : "06b8feee-58be-4ee5-ae3c-b1ebf7735d31"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Customer 24 Member - e9d457c6-e44f-4fc9-916b-9c01a362083c"
} ]

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/d5128adf-76ea-46f3-97d5-e7b6b0debbe9' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJtT1k0NU9GdmIzYWlkaF93THdXb3p3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA0MzJiMTlkLTkzOGYtNDczYi1iYzBjLWRkZTM3ZGM4ZWUzNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NywiZXhwIjoxNzkyNjY0NDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZThmODIwNjUtMDI0OC00MTY1LTljNDktMTkyOGZiNzE1NWQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Uop3Za0rGAdbvs0ZeYqxXC0PFPEPaXZ1s2cRw7NywcFgN447DbavvvjGthnmV3RfM1TSlDC_Qye_XY2sz4ixqOwWmTvZ2J6h5JCygpOIakdKvhzp-oHlZN-9tLZNNoG7zhiM8wKEqWPm0RQ0qL1QT1LY58Tn7dVf9BRJoHM_8SKNpXVlH6Yw1IZ5oCK_7JfrhDswaH4_a-0Fiq7EgRaY5SMKMKsdMBxmSaezyzIv0uHKaLpSW4sQLI-Xau0sFOAhrTyF3s9NaNGBhztOBBUebQangZrkXhOevN0xyXPcysKqMsm9i05sN3gJ0WI_LlArus8KXuiFXkh_g2JmgasoCw'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 596

{
  "id" : "d5128adf-76ea-46f3-97d5-e7b6b0debbe9",
  "standardRoleTypeId" : "f280496d-4a41-43d3-9110-9642f2ac7227",
  "createdBy" : "6dbab458-4673-4574-94f4-cb79d134ace4",
  "createdAt" : "2026-10-22T09:21:27.187203Z",
  "updatedAt" : "2026-10-22T09:21:27.187203Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "0f05b5cf-235c-42cd-81a5-091944610606",
    "resourceTypeId" : "4ee444af-3021-4722-9564-75bab996b954"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 179 Admin - 0f05b5cf-235c-42cd-81a5-091944610606"
}

Create Standard Role

POST /standard-roles

Authorization

This endpoint requires the following actions:

  • create action on the standard-role resource type

  • read action on the standard-role-type resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

standardRoleTypeId

String

true

Client must have create action under the annotated resource.
Client must have read action on the annotated resource.
Must not be null.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJ3QmVUNHZjMU1feE9yUmdPalUyRnhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNiZDkyMmM0LTFmNWQtNDRjMS1iNzJmLTViZDBkODY0NTA4MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NywiZXhwIjoxNzkyNjY0NDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGJhNzkzNWEtZmEwMC00NThkLWFiYTctMjBlMTY5NWQzZDY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fSx7XCJpZFwiOlwiMzgzODIzZTItNGYyYS00ZmFiLTg0ZjUtYjBmYmI5NTkxYThhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.a9a_Dj2sDFpzpUNOYxvKNpFHbaeazuQPhj2XOOv3lhVXorA-dwvbjd8yLiuli0i9Qyks8-X9D8QQgejcubnss36CyVZPW_gERYFA7kGidiyxO2z0mGU0GoNN9h45RGSWk_ySEROx5ilrT0ifbFWjB2K9xcpUSN3ekew45uHfjuM9izngNgWhm2cjGvkkyc6svn8ZKCWtrJMNY9td71nfNffBLS76DVkmN1yQ-ce079i6gUNXFvIJTw_OkHkN42Tpz1CFrccjHs3kdlFWrGPaZCJtVToesAjEoLrQHIuL89dXYl44whwHeEOaFzsX89LvnM7XAzXlx2T2skX6OTUi0Q' \
    -d '{"standardRoleTypeId":"9d480469-4bfd-42ed-99e6-b801c28602af","path":[{"resourceId":"42773c14-8ffb-4490-96c6-5a1cbb547f9b","resourceTypeId":"8a0dbfb9-a803-4fcf-b6ab-7ca7a07942ad"}]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 596

{
  "id" : "d766d444-a7f1-4088-91ab-c186a44d2d32",
  "standardRoleTypeId" : "9d480469-4bfd-42ed-99e6-b801c28602af",
  "createdBy" : "cbd922c4-1f5d-44c1-b72f-5bd0d8645082",
  "createdAt" : "2026-10-22T09:21:27.305354Z",
  "updatedAt" : "2026-10-22T09:21:27.305354Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "42773c14-8ffb-4490-96c6-5a1cbb547f9b",
    "resourceTypeId" : "8a0dbfb9-a803-4fcf-b6ab-7ca7a07942ad"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 181 Admin - 42773c14-8ffb-4490-96c6-5a1cbb547f9b"
}

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/f7396f16-b9e7-42a4-a0a7-8940fae94be4' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiI5XzBmWEROLTlxNWJ5UWFKVy1Eck9RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY2ZGEyZmU1LTM4NjEtNDdkZC1iY2M0LWNjZDc1MGNmOTQ2NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NywiZXhwIjoxNzkyNjY0NDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWYwMGM0MTQtODQwOS00ZGJjLWExMmYtNzBjMDE5YjM0ZjlmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.oSl4a-aytbABoLSdEMTAWLuIHH-EyoICFuy22PlbPiUR5nfe9QRINYInI4aNm5tOuBj81HxZI8_dXmUDXdiEaj_ZN5w4nYAcJDePioK0XwEXi-WUxQyH73EGxlUtXyjnzwTuS4EpnlJtSKiJvccmiBLSXWfWzjNuLKkCYUVlRvaipAQ8xAOqiPWvsKBoBz6P-x5dhi5BowYIKimb1jAEW1JWdOp4iYbeE9V7xPLWCmnb5gv_grA-RivHYr91xsW9O-iNZayt3ZDwldsMGaQ3MmFxAx-pQBaoYOQZQL0F0JKfnum6EFDW4ZfWnaL4qwvU-bqhkGyIi3D-dOm-o7TNPQ'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiI3YTZIVjRYY3lGcFQ1VnhGNXZ4MElRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNiMTk0OWVmLTQzNDYtNGYzMS04MTUzLTcxYzhhMjU5NGMyZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NywiZXhwIjoxNzkyNjY0NDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTExYjJkMGItZTRhZi00Mjc5LWE2MGMtNGMwMjU1MTI4OGMzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QxdRoI-DBJm1Y5bpyLzAAAT8K7o5C5qmyql8MreHT5AYQsfmaYOjshSHkkOb1gDNHMFvmQAVcWgkeHWkqZyPbspLFuAPqMzfLBUNMo7U03pyBV8lZVg6o-LAKW4ciXbMt1083PtMF5Pp9bwHYg5dafKs2C5A5N3v2vJdqRxUWvrUyqGcOtnCDkHr9Y5_zwgXfOGRgqT9IzaXfZuiBOhQBJrYytScFkXbKJN5gAyLCc0Fv0FXikcslJtbY8JK_-omOuPhgndsjB-CemXVJeA6LkWJ_8WMWA7J2G8UdkkVosMVUMTgev5FDAieO7Lj46AXKwW6AsgTmcxLHfNWaYUSLA'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1485

[ {
  "id" : "9830685c-c990-4ede-8159-56e69a5ffad0",
  "identityId" : "182b2647-5bf0-43e3-81d9-de6fe57e4b68",
  "standardRoleId" : "bbb66518-fec4-42aa-a94a-b547dfcba546",
  "createdBy" : "a8b88f10-ffb8-4638-b0e5-d5e48bced3fa",
  "createdAt" : "2026-10-22T09:21:09.895385Z",
  "updatedAt" : "2026-10-22T09:21:09.895385Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Customer 29 Member - 431c2294-c1b7-4632-b54a-5002a92f9661 to identity 182b2647-5bf0-43e3-81d9-de6fe57e4b68"
}, {
  "id" : "d0edaf97-8b69-4173-8c86-92da892b3c2e",
  "identityId" : "dc29d9e7-a932-4c1b-8702-69d0911a090f",
  "standardRoleId" : "280612cd-c878-44ed-9648-d3e9695927c2",
  "createdBy" : "9be73d97-9ffe-4819-a305-6ec333e5c750",
  "createdAt" : "2026-10-22T09:21:21.538435Z",
  "updatedAt" : "2026-10-22T09:21:21.538435Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 145 Admin - 3f77f837-8173-44a9-874f-07805c3120ba to identity dc29d9e7-a932-4c1b-8702-69d0911a090f"
}, {
  "id" : "0bac8adf-16b4-4664-952d-5ce83f48c75f",
  "identityId" : "508f661b-08df-4131-8ad5-2312391c0eb1",
  "standardRoleId" : "ac49703b-b452-43a5-beea-051795a83c9a",
  "createdBy" : "9f8404c1-dd17-40c0-9e31-c4b6c97389cc",
  "createdAt" : "2026-10-22T09:21:09.646957Z",
  "updatedAt" : "2026-10-22T09:21:09.646957Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Customer 24 Member - e9d457c6-e44f-4fc9-916b-9c01a362083c to identity 508f661b-08df-4131-8ad5-2312391c0eb1"
} ]

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/0886c497-9cc4-4864-a263-13206c48d029' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJnSXhTLVEwQUJvTlF3LTZXX0x1Ni13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY4ZjcxZDU4LTJhYTAtNDFjYi04N2IxLWJlN2Y4OThmYjM5NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NywiZXhwIjoxNzkyNjY0NDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDEyMDkwOWEtNTllYi00NDQyLTlmYTItMzYyYzNiZmFhZDU5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.nv1I-9iZOqpN9rs9vR7ODYXpMy3CObSJY4r6WtpVzUjSsOG5nOMcx74P82q_E8mjoFk9oCV-Gb94lzPq-E5Lmt9MYePyWtyQUAIzWckUTbGkgdYf_yeJtEL22_tSiGSFYSs5OnC4h0ClgzLRMC4qlS-Anac9AKKdzFOCtG_Wk8M7ySL8Hgx1XBcCJkWArd1rOJ6Ka5McwYcJOFXOFbVwkc1bhFLuWTO4b8xVfOLSDn6Y0sMaxTju8EskYs9CET5axqfXt9M37RePTmQay9yTHQctFh3RJzxe4Vx2YD_77d9qmmwADNn7iV2UeKVOk-fGamqPRtLq-H9vmmxvOZykRg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 493

{
  "id" : "0886c497-9cc4-4864-a263-13206c48d029",
  "identityId" : "23c3c33d-de5a-4bfb-ab99-acfee01d1126",
  "standardRoleId" : "985d064d-ca81-4fef-82b0-942c26d920dc",
  "createdBy" : "fb2c3d7b-ae34-4a8e-aa25-158cff3093ac",
  "createdAt" : "2026-10-22T09:21:27.977010Z",
  "updatedAt" : "2026-10-22T09:21:27.977010Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 193 Admin - b24996b1-3f11-4f1b-ab1d-e8bf8b327b61 to identity 23c3c33d-de5a-4bfb-ab99-acfee01d1126"
}

Create Standard Role Grant

POST /standard-role-grants

Authorization

This endpoint requires the following actions:

  • create action on the standard-role-grant resource type

  • read action on the standard-role resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

standardRoleId

String

true

Client must have create action under the annotated resource.
Client must have read action on the annotated resource.
Must not be null.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJDREpEWE5LelpqT1B0cmlTWVkyMC1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNkOTRkOWUyLWQwMmYtNDRhNi1iNjBlLTRmZjBmYjY5ZGZlOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NywiZXhwIjoxNzkyNjY0NDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODUwYjZhMDYtNDg0My00MTc0LWFkMGEtODM3NTE4YzNhMDlhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fSx7XCJpZFwiOlwiYWMwMTNkNDYtYjg2OS00ZDdiLTlmZDAtYzliNGU5MDcwMzRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.e_XK9fHwHq9MALNnu0X0H3iBo8jX0zYW1FTBMwhSeBgzNnCeZ1m1u6gpmek4e3WmKQOQlkHl8t3cm6TJP3VemxnPmEd7AcmkyIwwwC1DvxP_KE8D2HkAan5ibc8na0SIHfge9w_CwJUiPGmeAxrSvbOSCRTqvJVS9FuZuxtqlXAIF8vcksyDt519_esTJ22SglQwfhlNBCuS4jtOEZrhHAUM2YQRRWktR-UF2HUiN8pmBMGQVnjiEtSXM7IbYyMbw0ucStsLacAwGv309I3AJMSNZxv56oSgu2vmP8-POPtI0cA4gUjRGXEduN2jHUiFmaPf3mV3oXVf2RKuFdnEjg' \
    -d '{"standardRoleId":"b4632d14-5470-4f72-b536-227fb8b747a2","identityId":"55ee8b28-f400-4f21-bcda-ee3fb0b15a27"}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 493

{
  "id" : "c05a2035-be0c-4d56-84d1-cdcb505dbdb5",
  "identityId" : "55ee8b28-f400-4f21-bcda-ee3fb0b15a27",
  "standardRoleId" : "b4632d14-5470-4f72-b536-227fb8b747a2",
  "createdBy" : "3d94d9e2-d02f-44a6-b60e-4ff0fb69dfe8",
  "createdAt" : "2026-10-22T09:21:27.839105Z",
  "updatedAt" : "2026-10-22T09:21:27.839105Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 191 Admin - aad28d47-3ad7-4e80-a829-a20863056984 to identity 55ee8b28-f400-4f21-bcda-ee3fb0b15a27"
}

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/1e8bf7ca-a917-4afd-ba5b-52dc4ca589c4' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJnMGZmaEJrNEtFR3A5VFJJeTNKYUVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgyOGNlZDhhLWJjZWQtNDUwOC05Zjk4LWE2ZjlhZDI1ODFjYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4OCwiZXhwIjoxNzkyNjY0NDg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMmM5NTZlNmQtOGMzMy00NjFmLTk5MDEtOGM2ODE5MmM5NTc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.o4UFm0Z23r9SoiHsmwCZBsjVJMMY3w2byPy1hlZ0cSXuqF86VrinGb8EVc5wYiiaAqm27drxnrFo2m810Qyn9tmTcEURCNtfrVTtRo1mOHF2mGTWjsNxBwnPCGBv6YOotu7hGZMjkn1iHGt6WDYtHl9dkbcBHeQS_7oE0k4O7ke9yo3t6MIYC7ysooWlryce95qV6dLqssg6vqdvnnQnxuGyKvIdvgaXlpsEpqDpltbb0wygyq8rpm2pNDXdvsXuYqB4bzsYYv5eFmV80QMO56k4WpR4mR5EjDTIPKc-eEWP8Rn2BAo8KxuS8Kc8DeHsv_rkKbNgwrbhVUie8pcTaA'

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..

authorizationStrategyId

Object

true

organizationId

Object

true

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.
Size must be between 1 and 64 inclusive.

[].authorizationStrategyId

String

true

[].exclusiveToOrganizationId

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

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJiZUZ6STlZV1Q4NVdqbjRJU25zdS13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY4NTlhZGQ5LTYxY2ItNGQ0MC05NTI2LWRjNWM2NDg4ZGEzYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4OCwiZXhwIjoxNzkyNjY0NDg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWEyMDdlZDctYzhjZi00NjNlLThkMmEtN2Q4N2I0YzhkNDRlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.BnqH2IyX0JcfhjjiQNKbFsJQDH9y31ldeSHSctQysEeJJAbE-eCZGUH1-n8NM2PPa-ZowFWPn1HDHJ-loGWKT6gbGtWKsQZ34KBIAuezywlGiyZj80MP-K_GAf4WJOUfAynLSEZlCYLL8eIkt3vTzeeT43FtrbuKhKbR8X-tHwBHXwhHh24KAktqG60UmLdevC23cZrBft-6HFHKwLs24_8bVNnlZ884VhExKG3cNLkPQRNWneYeHZzBTsqg4cjbQerp8JWxQ1qIqblUkkVVUWLSFdsuO07QtlFNrnaljbZud1e8yffWAx9amSni6LYCiPMLMwNS_4XeH3uQmhhE1w'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1514

[ {
  "id" : "0b6e202b-fd73-42d8-91a0-eabaf16ec86d",
  "resourceTypeId" : "dd4452e4-f0a5-4e3b-befc-b2127e358b3d",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : "a0710000-0000-4000-8000-000000000001",
  "exclusiveToOrganizationId" : null,
  "createdBy" : "d5f48ba5-283f-4cf9-923b-bf4c557a5044",
  "createdAt" : "2026-10-22T09:21:26.936261Z",
  "updatedAt" : "2026-10-22T09:21:26.936261Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Test Type 173 Admin"
}, {
  "id" : "bc003be0-e85c-4f38-a51b-9a55ce8b8107",
  "resourceTypeId" : "c27f93c2-3afc-458d-a1f1-7ed6e6944205",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : "a0710000-0000-4000-8000-000000000001",
  "exclusiveToOrganizationId" : "2cf81a57-47b6-40ad-aa21-c1e38e1ed8d9",
  "createdBy" : "50cb9017-91f0-4f32-bda4-d35f13e998cd",
  "createdAt" : "2026-10-22T09:21:26.867269Z",
  "updatedAt" : "2026-10-22T09:21:26.867269Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Test Type 171 Admin"
}, {
  "id" : "32e061e2-7307-4175-8389-19fa04634ed1",
  "resourceTypeId" : "65dc4b43-d492-4c86-98b3-14e3b3794754",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : "a0710000-0000-4000-8000-000000000001",
  "exclusiveToOrganizationId" : null,
  "createdBy" : "7c8948ff-5bb7-4853-a84b-4bf40750e33d",
  "createdAt" : "2026-10-22T09:21:11.835401Z",
  "updatedAt" : "2026-10-22T09:21:11.835401Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Test Type 63 Admin"
} ]

Get Standard Role Type

GET /standard-role-types/{id}

Authorization

This endpoint requires read action on the standard-role-type resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

resourceTypeId

String

true

Must not be null.

authorizationStrategyName

String

true

Must not be null.
Size must be between 1 and 64 inclusive.

authorizationStrategyId

String

true

exclusiveToOrganizationId

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

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types/b1a2c53f-b61b-4d4a-8c7d-e452afb81736' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJGNDZDVWdEaUN3dTFyMXhUMG5XR2l3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAxZDgyN2MyLTQ1YTAtNGNhNC04MTM5LTMxNDc5YWQ1OWY1NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4OCwiZXhwIjoxNzkyNjY0NDg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjBjZTVkODQtMzI3MC00MmNiLTllOGItNGFlNDhkZDJmZjQ0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DQVWWpJTmIsaUeOa-BN1dVcLATLcKNcZ4SPgQPhRCY62zIE3hNNmAKQGZg1odH36ZYkpmnnxfImTxOAZYuCv-u_iUlMIuAnVO4cEl6ZGcnSdVw634JPukt77omwQKQ2zt3CFMLrfuN284qU4NPYu5L5CvadTTZx7cnzADgm45hntOnef3REFYp-sStcuGkK5PCGCylfRYVPbYozoj-qcNat2rm2jc4prMRcu6bCGg_H6XS9F9_7kK1XRrzm_MIv9kd_26bKtfkY9WV4fIFiU-rAVwrQblWy-CNXbi9bP2HBpkWmlpkUS1iL_cYoPdXyomjqRvFbmtjkllOwtkqzO7A'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 491

{
  "id" : "b1a2c53f-b61b-4d4a-8c7d-e452afb81736",
  "resourceTypeId" : "1d6b9d07-2fed-495d-89a0-31f36f26f4fe",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : "a0710000-0000-4000-8000-000000000001",
  "exclusiveToOrganizationId" : null,
  "createdBy" : "af14e32a-9b73-4f73-bcd4-025c153a51f8",
  "createdAt" : "2026-10-22T09:21:28.514777Z",
  "updatedAt" : "2026-10-22T09:21:28.514777Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Test Type 203 Admin"
}

Create Standard Role Type

POST /standard-role-types

Authorization

This endpoint requires the following actions:

  • create action on the standard-role-type resource type

  • read action on the resource-type resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

resourceTypeId

String

true

Client must have read action on the annotated resource.
Must not be null.

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.
Size must be between 1 and 64 inclusive.

authorizationStrategyId

String

true

exclusiveToOrganizationId

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

_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJQX0lsTm5LX3ZyaHlyODlGVGVEZFVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFhNTdhODBjLTY3MDQtNGJkMy1iOWQwLWRlMjU0ZGU1YmJmMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4OCwiZXhwIjoxNzkyNjY0NDg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTZmMzJmN2YtOTI5YS00MGFiLTkzYjUtYTZjNTdlZDFhNjhhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg4fSx7XCJpZFwiOlwiODkzY2VjMDQtMmYxMi00ZGVmLWFmZjUtNGUwMTFjYTE0ZmU1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IYRjAAdTI6hqlw508H4UHEScFkHEKyIksgTkSoztwo_Ssj8X2-MFOYRhDhJwqo78FaT7pjW2fXkjbU6sVweu10iPO0cLI0Ts3x_BgJpNOYQZ6FsIzUukvvDmLdem_J_FhnOQili1Z3eDmJGbp2_t07snz5uRNPlVYHp_HKBYJpQq-3b2SDXH9ttLBg_KBXgQbBK1ye9FvwL-eJr-3QnJ65zCjR2n5POp3GFnlEG2lcwqCMFUGGylNjLOK-6O7-FXYc_ECcNxNqX-F6xpUVahtT8ARGkr3ef1gtNGJXBDvPtV6fPaghaGsuIMGAjDWql8bjkbCnRH2_I-yq03Jh_Btw' \
    -d '{"resourceTypeId":"06d745a6-05ad-4e8a-8702-c4f7e4d99094","authorizationStrategy":"Admin"}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 487

{
  "id" : "50f968d7-66fa-4ec0-9906-fc0eb32d979d",
  "resourceTypeId" : "06d745a6-05ad-4e8a-8702-c4f7e4d99094",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : "a0710000-0000-4000-8000-000000000001",
  "exclusiveToOrganizationId" : null,
  "createdBy" : "1a57a80c-6704-4bd3-b9d0-de254de5bbf0",
  "createdAt" : "2026-10-22T09:21:28.468657Z",
  "updatedAt" : "2026-10-22T09:21:28.468657Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_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.
Size must be between 1 and 64 inclusive.

[].authorizationStrategyId

String

true

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJlb0x1ZFMySERvVThQZy1JM2sxTTJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZkZmY4ZmE1LTRkZjEtNDBmZi1hODRmLWE4N2NmYzAzNzQyMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3NSwiZXhwIjoxNzkyNjY0NDc1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2NkZWExYTItNGVkZC00ODU3LTllYjItM2JjODM5NDZkMWZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DZLHQ_ByZxMd85cHRF-BNagxogEVuAJOLRil6xXRiWbNyj8zUgR82CKk_AeYONX9vzevxlSb4BERIM0VmfVxOOlPG7rnFxMyk9d52dq_4EQkgo_SvOBBXt4CbQlumBJqtNFHM2wopGtM5bj3aYxojwwoqZXRd5jCV_av8zPz2mUjUeWo0nhDdA65uekdPJHXCSqkwDbPS5G9w6NIfUVelWCyaTEDw213145nl-tRkJmdRIZR8RTO-eY5HglUOj0UaW_fL-YVatvZ6Q3T_Q2Y1qNzVFtI0KxnLGZHSWO_U9SKfT9ARep30sYP4Ypgv-KgziOjfsoAwaOBpqUsFLXqig'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1697

[ {
  "id" : "7fb4733e-ab60-4efb-b1ce-967c173dfd14",
  "resourceActionId" : "04b83f89-4892-46b3-9d6a-39469f30943d",
  "authorizationStrategyName" : "Member",
  "authorizationStrategyId" : "a0710000-0000-4000-8000-000000000004",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "f19456ca-b54d-43ac-88f7-34f7f488024d",
  "createdAt" : "2026-10-22T09:21:10.562676Z",
  "updatedAt" : "2026-10-22T09:21:10.562676Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Connectivity Location 50 in Member Standard Roles"
}, {
  "id" : "34a28722-89e0-4f45-acae-e41a05655eaf",
  "resourceActionId" : "e0943017-815b-4c6c-8f46-e5d57fc7f05e",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : null,
  "includeWhenAbove" : false,
  "includeWhenAt" : false,
  "includeWhenBelow" : true,
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:58.351138Z",
  "updatedAt" : "2026-10-22T09:20:58.351138Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Delete Frontdoor in Admin Standard Roles"
}, {
  "id" : "54721c95-672f-4455-88e4-817475a2034f",
  "resourceActionId" : "0a576ced-b397-47ca-9516-7df46bfc6d88",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : null,
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2026-10-22T09:20:54.052314Z",
  "updatedAt" : "2026-10-22T09:20:54.052314Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Update Public Grant in Admin Standard Roles"
} ]

Get Action Inclusion

GET /action-inclusions/{id}

Authorization

This endpoint requires read action on the action-inclusion resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

resourceActionId

String

true

Must not be null.

authorizationStrategyName

String

true

Must not be null.
Size must be between 1 and 64 inclusive.

authorizationStrategyId

String

true

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/9dd9586c-6b88-462c-8894-86482312647c' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJhU1VqQ1lEQVhJcWNBQWFqV1dHdjhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAxMjk5YTMwLWRjZmQtNDRhYy1iNjk0LWYwNzAwMzQ4NGE1MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3NiwiZXhwIjoxNzkyNjY0NDc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTNmOGE3ZmYtNmRkMS00NzAwLTkzZmUtZDk0OTkxMDRiZTQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.BCP9UblUE5H6vzk8QHmnkTX_2Cbj6C1o_S0AJXSgZdOTqqeJ2KibPGRX8CnKGIKwoWSg95QMX6l-ielraNtZeJTKGmSLFPRYZh-HOTJG_g5y10yaa00DqlwR2Mbd3fVnxgLZeyOVvaXIVEUJfkaWLImEbZz02Wl3H65sF_jYJJ9X05DgvSxsMQlPkduAPKylh_dxxtyJt0nOufxOnygb0erV9hV2vP2GrKbuzFI9BOI8lS80zdlFxfUVRebMbOOrQivrvFk4DGVJ6rUHtuez-oY5cLunjMhujb1TsRDjQSdm5FLPoSAl8wF7Aee6EQodecEcei8LGdSe1HDF8bBFlA'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 594

{
  "id" : "9dd9586c-6b88-462c-8894-86482312647c",
  "resourceActionId" : "85bd90f6-8f50-4957-93bc-23c2270f014f",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : "a0710000-0000-4000-8000-000000000001",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "1d5f815c-943d-46a3-81f3-f286cdcf2e51",
  "createdAt" : "2026-10-22T09:21:16.849704Z",
  "updatedAt" : "2026-10-22T09:21:16.849704Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Test Action 108 Test Type 107 in Admin Standard Roles"
}

Create Action Inclusion

POST /action-inclusions

Authorization

This endpoint requires the following actions:

  • create action on the action-inclusion resource type

  • read action on the resource-action resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

resourceActionId

String

true

Client must have read action on the annotated resource.
Must not be null.

includeWhen

Map

true

Must not be empty.
Must not be null.

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.
Size must be between 1 and 64 inclusive.

[].authorizationStrategyId

String

true

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJzd0FHNWFxNzNkZzJSWko4NW8zcTRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIwNmZkZTVkLTQyMzctNDc5NC1hZGYwLTQyMTllNmRmYzJmNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3NywiZXhwIjoxNzkyNjY0NDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWJkMjBkNzctYTNjMS00Y2NmLWJjMWYtNTQ1ZDZhNWM3YjhlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc3fSx7XCJpZFwiOlwiNzYzODgwMDYtNGE4YS00OTRiLTljMGEtMWQyNDNmYWE1ZGE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.lOIsOpLalKmqk0a4nhmvo8nSbIjHhxXaT7bWr962QlJRZCqdb-jqEKpnnoy_jEjwa9yUanM9fQo5YTzdq8WWGTGebI0PPKOUFPBbYyzt06hzJ0unVDa13A2xW59l7bj5-KuYw-4pqEzhX37qYmqS9lFqUcZ4vuQwRKCrKeBlEV-YNWKGvNA8FnYLJhmuKLtHw_ML9UZdRHPSgf3RxqnouLJQEvZarNpmwAHOuzrMH48ufNSe_qUbmapXWfhV_iICfwGr18kpoLO2GmTpPebYCMc2nsMKqLNd1MHwL1yTeB2w3rjwgxgAR_Yk9mqHt-nnivBblyogNMPOe158mxVC0Q' \
    -d '{"resourceActionId":"a8b15e03-8d37-44bb-9566-003e7daff34d","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 598

[ {
  "id" : "79f1d260-5858-4658-8bd6-c32efae88a21",
  "resourceActionId" : "a8b15e03-8d37-44bb-9566-003e7daff34d",
  "authorizationStrategyName" : "Admin",
  "authorizationStrategyId" : "a0710000-0000-4000-8000-000000000001",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "b06fde5d-4237-4794-adf0-4219e6dfc2f5",
  "createdAt" : "2026-10-22T09:21:17.110585Z",
  "updatedAt" : "2026-10-22T09:21:17.110585Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Test Action 114 Test Type 113 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/d9b7885f-694b-49f2-990f-b67038db77aa' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiI1NE1ONGtFbHdjZjY2ODd4aGVzR29nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ4MWQ0NTlhLTA4MjctNGU4NS05ZmM3LWY0M2I3NDdjOWVhZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg3NiwiZXhwIjoxNzkyNjY0NDc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGE4MDg5NjgtZmEyNi00ZWRjLTk3M2UtOThlOGJiYzIyMjRkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODc2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Hc39OvwgMZAdWQtl9dWnEaIvWdUXT7sh9S8LSRYP4W_rIbqndzcFkwcvL8Ukmk9igCuIWJt3_YZo8vpYH8JMWOM51YMZI7_0CBjrwTuIT5Cr3oLq5ukflTVaQ_bvkhSMgn-kkGvrgoB03qCAbuyetgGQ9NxJKZWfeZW4b-xkDiW45NV83Blutd9XrMO6mrtm3Etj0lY0-sDWFAgBj19GbmjzYXQIQZvu5i-yXwEp5kq547tRWEk1LMxAVU1JWfJaPqhgx_B7DH9hmvYf64BxlwSTpTh4YnDm3xZRusCjL0bm2MUISwlTFhB1kGIco3hvS8DSeWEkXFSVIO0wBCkZBg'

Example response

HTTP/1.1 200 OK

Role Templates

A role template is a custom role for one organization only. A create also writes the authorization strategy, the action inclusions that tell what the role confers, and the organization-exclusive standard role type. All four writes are in one transaction. A delete removes all of them, and each identity that holds a role of that type loses it.

A template defines a role. It does not give the role to anyone. To use the role, make a standard role from its standardRoleTypeId and grant it, or make it a default role of the organization.

Each response contains the template with its name, description, anchor, role title, actions and audit fields.

Choosing an anchor

The anchor decides how far the role reaches, and only the configured resource types are eligible. GET /auth/v1/role-templates/eligibleAnchors returns the anchors that the client may use. The endpoint applies the same two tests as a create: the type is eligible, and the client holds a permission on it. Thus, a create does not refuse an anchor that the endpoint returns.

Both picker endpoints need permission to create a role template. A client without it gets 403. A client with it gets an empty array when it holds none of the eligible anchors or actions.

Choosing the actions

GET /auth/v1/role-templates/eligibleInclusions returns the actions that the client may confer. A template can never confer more than its author holds, so the answer is the configured actions less the ones that the client does not hold. The configuration can permit each action of a resource type. The endpoint expands such an entry, so a client can send each result back as an actions element.

Validating before you write

Send the nf-validate header on a create or an update to ask if the command is valid. Any value of the header is accepted. Nothing is written. The response is 200 with a JSON array of faults. Each fault has the path of the field, its label and a message. An empty array means that the command is valid.

POST /auth/v1/role-templates
nf-validate: true
[ { "path": "$.name", "label": "name", "message": "..." } ]

Find Role Templates

GET /role-templates

Authorization

This endpoint requires read action on the role-template resource type.

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

organizationId

Object

true

isDeleted

Boolean

true

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

[].organizationId

String

true

[].name

String

true

[].description

String

true

[].resourceType

Object

true

[].resourceType.domain

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

[].resourceType.code

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

[].roleTitle

String

true

[].authorizationStrategyId

String

true

[].standardRoleTypeId

String

true

[].actions

Array[Object]

true

[].actions[].resourceActionId

String

true

[].actions[].domain

String

true

[].actions[].resourceType

String

true

[].actions[].action

String

true

[].actions[].title

String

true

[].actions[].above

Boolean

true

[].actions[].at

Boolean

true

[].actions[].below

Boolean

true

[].createdBy

String

true

[].createdAt

String

true

[].updatedBy

String

true

[].updatedAt

String

true

[].deletedAt

String

true

[].deletedBy

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/role-templates?organizationId=8c3120be-ba01-4b55-a27e-7ec3486af54f' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJXN3drRUx3aWI3azdXNXYxM1Z3cW13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY0NGY3MDZkLWY5ZmQtNDAyNC04ZTk0LTEwYjM3ZjMzZmQzYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NiwiZXhwIjoxNzkyNjY0NDg2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTUxODYwZmQtY2Q1OS00OTUzLWI3MTgtMzk4NDdmOWUyN2M0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.atXJlD6D0fdSQR3ZmoqESfkIxiKn5qm-lh-fBTaqXGUt5kpvk3TYyL2hMthMyNF24Vbng0Fua8HyGoUkE130RLyXebViU4wwY9HniJUJeLTCIEJfBYRrFli9D4YNjg6JJ9A8VzqyOjmX4Rw1c7RX_T6JWewR7t0SRMaphYeT-oHs9dgTftY34Dmu0ce2sYRYa0gTl9v1Qr-9DwNKyUm2MX8PPmiStC-ArlWKag6jgC1XnDaZhpoMv6t0cVDtVpAFpeWrZjsM0HvIK7RihL-AYdm0GJvPMEyrLEnSgMw72hSFz4yibtF9dmFQgF2f9BC7nNUC46HnIoXLniOxbxujeg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 966

[ {
  "id" : "2b69175f-a0f8-4e41-9449-0456e6c47514",
  "organizationId" : "8c3120be-ba01-4b55-a27e-7ec3486af54f",
  "name" : "Service Manager",
  "description" : "Read and update services beneath a network.",
  "resourceType" : {
    "domain" : "io.netfoundry.network",
    "code" : "network"
  },
  "roleTitle" : "Network Service Manager",
  "authorizationStrategyId" : "1dc73b6d-259b-4a21-acef-a7575f2b1569",
  "standardRoleTypeId" : "d515b2eb-09e0-41af-8974-0405aef78aeb",
  "actions" : [ {
    "resourceActionId" : "e6a7fd89-d2a7-4843-87ef-f2d0a271e798",
    "domain" : "io.netfoundry.network",
    "resourceType" : "service",
    "action" : "read",
    "title" : "Read Service",
    "above" : false,
    "at" : true,
    "below" : true
  } ],
  "createdBy" : "ac68d758-b930-422c-a0ec-2b473e670c00",
  "createdAt" : "2026-10-22T09:21:26.098819Z",
  "updatedBy" : null,
  "updatedAt" : "2026-10-22T09:21:26.098819Z",
  "deletedAt" : null,
  "deletedBy" : null
} ]

Eligible Anchors

GET /role-templates/eligibleAnchors

Authorization

This endpoint requires the following actions:

  • create action on the role-template resource type

  • read action on the network resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

[].domain

String

true

[].code

String

true

[].name

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/role-templates/eligibleAnchors' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJUNlRhOXpZVmNud0xYYzdYWTEwdm13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQwNDY5YTFlLTQyMDYtNGFlZC1hM2U4LTE0NDM1NTNmZDAzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NSwiZXhwIjoxNzkyNjY0NDg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjdlZDkxZTUtNjY2Ny00MWM5LTg4NGMtZDUxMWE3N2VlMmQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fSx7XCJpZFwiOlwiMDBkMTRmNDUtNDM1Zi00MmEzLWFiZGEtMjY3MTI2NzJjNjg2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.OtWQE_tyr654mWsfG9xw3fB2WFsQgumWfHJPpC3XW1KEJvxuauXqAXAadC3_U_3GdpCXpsSPVIEskpE1YNWkaipd7sAB68AQyXlZrha5s6f-CHHf-phqLYXenJkq5rOtDhHvU3CHW9-T3MZEwq0chUDoFiAuJuVtb8EPGRA4kvw9kP_1cizCvQcOxW3zLPqmlThU84PaLZkBGWK_OwhK2UJ9-QKYgoI1n3m6Q_mGOU683MwKfCmdKfz3QKrSy6gWd950_Xh896e2m39eRfdG0dV3Mw_cOUautgUip34vT1KS5FUcgM3qOtDrzwuAlqW5rzSb26wjo9YL4-m1j6VDYg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 88

[ {
  "domain" : "io.netfoundry.network",
  "code" : "network",
  "name" : "Network"
} ]

Eligible Inclusions

GET /role-templates/eligibleInclusions

Authorization

This endpoint requires the following actions:

  • create action on the role-template resource type

  • read action on the network resource type

  • read action on the service resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

[].domain

String

true

[].resourceType

String

true

[].action

String

true

[].title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/role-templates/eligibleInclusions' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJQNFppRXJZQ2NrMWFFVnR0ekhVajl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY5MWI4NDQwLWEwODMtNGNlZS05ODAwLTVmODUwYzZmYmUwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NSwiZXhwIjoxNzkyNjY0NDg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWNhOWIwMTQtMDI0NC00ZDYzLWI1MGYtMTc3NWQzM2U3YWQyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fSx7XCJpZFwiOlwiZmY2ZjIxZmItODQ3YS00YTY2LWIyN2QtZGU2MDA5ZTk5NGJkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fSx7XCJpZFwiOlwiMGNhMGE2NjEtZmEyMC00ZDM3LTk2MzUtY2M5YzRjMzFlYTU5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.F0mD8kYcPUAyTxt5PBkjJ-msHc-NhKekH9ds9WPpN78XtfgPV57JE_qWars5TcNzaDBXl7AcmXmmJ_3NRQ33qr1bIa5WTJWKpUX1np3q2yvHxm_k3IbqIMmEyLPbey95X9wvneF0XlCG5hWngUeq32Q0k0NxqlSRSLnTXVEp-8PN-DqKL64yRWCjoFrQpuXVBqdLMR0NV9bdhKOsfocrsmHs1SvzASv9nPokhNsqq8hyuEaGEi56Dt3vFG4g7Bqw_ocG3qfFVixBtG1-Cgipf6QxSrttFAYdzgapFpJy96cuPSsgs2XZU9QZSxK6Qo1eWaWknMvmvjJAJOMI0-Grwg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 342

[ {
  "id" : "c7f547ea-5947-421a-8c93-cfe475c5899f",
  "domain" : "io.netfoundry.network",
  "resourceType" : "network",
  "action" : "read",
  "title" : "Read Network"
}, {
  "id" : "e6a7fd89-d2a7-4843-87ef-f2d0a271e798",
  "domain" : "io.netfoundry.network",
  "resourceType" : "service",
  "action" : "read",
  "title" : "Read Service"
} ]

Get Role Template

GET /role-templates/{id}

Authorization

This endpoint requires read action on the role-template 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

organizationId

String

true

name

String

true

description

String

true

resourceType

Object

true

resourceType.domain

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

resourceType.code

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

roleTitle

String

true

authorizationStrategyId

String

true

standardRoleTypeId

String

true

actions

Array[Object]

true

actions[].resourceActionId

String

true

actions[].domain

String

true

actions[].resourceType

String

true

actions[].action

String

true

actions[].title

String

true

actions[].above

Boolean

true

actions[].at

Boolean

true

actions[].below

Boolean

true

createdBy

String

true

createdAt

String

true

updatedBy

String

true

updatedAt

String

true

deletedAt

String

true

deletedBy

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/role-templates/85c6bcab-9160-41f4-a169-392c812cd7d2' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJPTC1sR3RSTVp6SXNPN1dTaFFDRHVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYxY2QwZWE1LTcxMTYtNDE3Ny1hZjE1LTZhOWNlMTBjOTgzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4MywiZXhwIjoxNzkyNjY0NDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWZmMDYyNDUtZTE5My00OTI4LTk3Y2QtZTY1ZTEyMDVlN2NhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODgzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.cHgHCNpEpQFqMiyLFBlAkcjHtrhrpGy9yMPqBXRnlSvW1S4D-WB_jpLn9U5YN-JiwCDvoawhlBbZVrXQW1bCAkT0z4PuRk8PF9umLefjlySMRv3BvU1ipuQZm8FRvGE74-J-fCzoMO2qAPC7lIMVK3WNAv65sluLbGEyh1Fcw70jsinu8bKngF9U84wqWdJgmKMy7_WiGGrnjmiPt0xF2WXpbVnHSEI3KUGTcYln76kCla4oO04ZsDGRPPM5SBftetOKC9VVvGlY17Ug2YMo1CMLZuYCR0lqCjABdwJrqxRlG1AwN84Tr0Lm15HT6jxs6ZwGsyU20eVbAD2prGULCA'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 962

{
  "id" : "85c6bcab-9160-41f4-a169-392c812cd7d2",
  "organizationId" : "bd1baa14-4226-413e-8a6a-ee0618676d63",
  "name" : "Service Manager",
  "description" : "Read and update services beneath a network.",
  "resourceType" : {
    "domain" : "io.netfoundry.network",
    "code" : "network"
  },
  "roleTitle" : "Network Service Manager",
  "authorizationStrategyId" : "4311b488-8bd5-41b9-94c8-4420e86e3136",
  "standardRoleTypeId" : "09be092d-cee4-4938-a79f-df0dd32efc72",
  "actions" : [ {
    "resourceActionId" : "e6a7fd89-d2a7-4843-87ef-f2d0a271e798",
    "domain" : "io.netfoundry.network",
    "resourceType" : "service",
    "action" : "read",
    "title" : "Read Service",
    "above" : false,
    "at" : true,
    "below" : true
  } ],
  "createdBy" : "96e510cd-5316-4476-9ba1-9f0998ef94f7",
  "createdAt" : "2026-10-22T09:21:23.857797Z",
  "updatedBy" : null,
  "updatedAt" : "2026-10-22T09:21:23.857797Z",
  "deletedAt" : null,
  "deletedBy" : null
}

Create Role Template

POST /role-templates

Authorization

This endpoint requires the following actions:

  • create action on the role-template resource type

  • read action on the network resource type

  • read action on the service resource type

  • update action on the service resource type

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

organizationId

String

true

Client must have create action under the annotated resource.
Must not be null.

name

String

true

Must not be null.
Size must be between 1 and 64 inclusive.

description

String

true

Size must be between 0 and 1024 inclusive.

resourceType

Object

true

Must not be null.
io.netfoundry.auth.domainv2.roletemplate.EligibleAnchor.

resourceType.domain

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

resourceType.code

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

actions

Array[Object]

true

Must not be empty.
Size must be between 0 and 256 inclusive.

actions[].domain

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

actions[].resourceType

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

actions[].action

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

actions[].above

Boolean

true

actions[].at

Boolean

true

actions[].below

Boolean

true

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

name

String

true

description

String

true

resourceType

Object

true

resourceType.domain

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

resourceType.code

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

roleTitle

String

true

authorizationStrategyId

String

true

standardRoleTypeId

String

true

actions

Array[Object]

true

actions[].resourceActionId

String

true

actions[].domain

String

true

actions[].resourceType

String

true

actions[].action

String

true

actions[].title

String

true

actions[].above

Boolean

true

actions[].at

Boolean

true

actions[].below

Boolean

true

createdBy

String

true

createdAt

String

true

updatedBy

String

true

updatedAt

String

true

deletedAt

String

true

deletedBy

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/role-templates' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJoeUtpQlpSbzhoRmw3Yno3aWhfX25BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM1M2VhNTUwLWRiOGEtNDM4Mi04OGExLTJkNzVkYzk5YzNmYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NCwiZXhwIjoxNzkyNjY0NDg0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmNlZDExYWMtNDJmYS00NDViLTg2ZGQtZTE0OGFmMjk5NzZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg0fSx7XCJpZFwiOlwiYjJhNGJhODMtYjE0OC00ZmM1LWEzNWQtODY1MGZlYTdjZWM1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg0fSx7XCJpZFwiOlwiNzMxOTE0YmItY2M3NC00MzBmLWFiMzItMzNiMjI1ZDIwOTU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg0fSx7XCJpZFwiOlwiYTQ0ZTQ1YWYtYTg2Ny00ZmQ1LWFmM2UtNjI4M2ZmNDIzZTY3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ih_tpUCEaO67bPlQE2lLOhVCiUhEZjpQEI_6b3IWSkcUFBQwydql6lt_C2-I2eVSLKvC2GUPb9qXJV98gywOeqj9KRmREiIyoEewP0xYozL60n3SOppinJ0CCLhxfZSmbAhYtTJ2Wyw7id8-Zs5jzxccAeVKv9-LQ-Hqmk3RfixWpe8k4-pf8OTegVw-k2PQx-onZzyjvMvnm2t3qXvBU9R0rF41xOBQtXV_qe8EM3X_1jyOaiAigivR8Lp17QBqLTXvrKhJ9ZUQHwVDLDcL_YuKn4p5XqypBiGTYRrF5iggcm5is8BUgABl6bZfNs0DarRLTafYczSpTLqZ19Vr9Q' \
    -d '{"organizationId":"2288f5d5-ea29-4f15-ba49-fe49abfb6951","name":"Service Manager","description":"Read and update services beneath a network.","resourceType":{"domain":"io.netfoundry.network","code":"network"},"actions":[{"domain":"io.netfoundry.network","resourceType":"service","action":"read","above":false,"at":true,"below":true},{"domain":"io.netfoundry.network","resourceType":"service","action":"update","above":false,"at":true,"below":true}]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1220

{
  "id" : "5ecf4f0c-0c06-4283-a16f-f441b1933092",
  "organizationId" : "2288f5d5-ea29-4f15-ba49-fe49abfb6951",
  "name" : "Service Manager",
  "description" : "Read and update services beneath a network.",
  "resourceType" : {
    "domain" : "io.netfoundry.network",
    "code" : "network"
  },
  "roleTitle" : "Network Service Manager",
  "authorizationStrategyId" : "dd642cef-4ba6-410b-ab72-049715ab94fc",
  "standardRoleTypeId" : "fa4c85a9-7594-45e4-99a9-12ea5b3fb5ba",
  "actions" : [ {
    "resourceActionId" : "e6a7fd89-d2a7-4843-87ef-f2d0a271e798",
    "domain" : "io.netfoundry.network",
    "resourceType" : "service",
    "action" : "read",
    "title" : "Read Service",
    "above" : false,
    "at" : true,
    "below" : true
  }, {
    "resourceActionId" : "85b523f6-4780-42b7-ab26-cd9c82905453",
    "domain" : "io.netfoundry.network",
    "resourceType" : "service",
    "action" : "update",
    "title" : "Update Service",
    "above" : false,
    "at" : true,
    "below" : true
  } ],
  "createdBy" : "353ea550-db8a-4382-88a1-2d75dc99c3fb",
  "createdAt" : "2026-10-22T09:21:24.396651Z",
  "updatedBy" : null,
  "updatedAt" : "2026-10-22T09:21:24.396651Z",
  "deletedAt" : null,
  "deletedBy" : null
}

Update Role Template

PATCH /role-templates/{id}

Authorization

This endpoint requires the following actions:

  • update action on the role-template resource type

  • read action on the service resource type

  • update action on the service resource type

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

actions

Array[Object]

true

Must not be empty.
Size must be between 0 and 256 inclusive.

actions[].domain

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

actions[].resourceType

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

actions[].action

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

actions[].above

Boolean

true

actions[].at

Boolean

true

actions[].below

Boolean

true

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

name

String

true

description

String

true

resourceType

Object

true

resourceType.domain

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

resourceType.code

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

roleTitle

String

true

authorizationStrategyId

String

true

standardRoleTypeId

String

true

actions

Array[Object]

true

actions[].resourceActionId

String

true

actions[].domain

String

true

actions[].resourceType

String

true

actions[].action

String

true

actions[].title

String

true

actions[].above

Boolean

true

actions[].at

Boolean

true

actions[].below

Boolean

true

createdBy

String

true

createdAt

String

true

updatedBy

String

true

updatedAt

String

true

deletedAt

String

true

deletedBy

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/role-templates/43197a07-fdd4-42f0-bbcd-fb05d9041dd4' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJ0dmtpWkFNUTU0MFp6OS1BaGIxN3BnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE1MDg0ZTRhLTM2NWMtNDIzMC1hMzlhLTM2NTFhYTYxNDc4OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NSwiZXhwIjoxNzkyNjY0NDg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTk1NGI1NzEtZWQ0MC00NzE3LTkyYzctNmI3ZjBlZTM1ZTNlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fSx7XCJpZFwiOlwiMGRiOGI1NDQtM2JjNS00YzQwLTk0NWItYzE5MjVjZGZmMzFlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fSx7XCJpZFwiOlwiZTdkM2IyM2ItMjE4OS00MGQ0LTlkNTgtMTRmZDZhZmJlMzU2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.nd0BKdExmNYKR2cPltekInaa07lbDOMMldzh-wIaFaxd20gXGpS6JgnKIycbl69VZAW3j3ljrrMyOcX0JqDykIFZO3zJxcyq5DVymx6FAQI8_0AwjtnBzm2MjkU77WkrDKFVOErhitWPBvjbkZW4Tp91OHNqZEN-UfjbscnJlY_izFih4XWbBNU3aDdxC9CT9KPxPwU0QZz5RMp9-hlKbT4QBerGYN6GNhmCmtZN9PAlOyvMKnzwE0Mmcuh0kyWj4rJxEZmac4jLU2FkZLlL8Ol5og-270wPwfLirBMuYrZm2X7LWuOPXWEan3_ICHKlb9J7_EPyCBhz7HHDbF8GMQ' \
    -d '{"actions":[{"domain":"io.netfoundry.network","resourceType":"service","action":"read","above":false,"at":true,"below":true},{"domain":"io.netfoundry.network","resourceType":"service","action":"update","above":false,"at":true,"below":true}]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1254

{
  "id" : "43197a07-fdd4-42f0-bbcd-fb05d9041dd4",
  "organizationId" : "3e02a9ca-f590-44c8-9f44-8a6b39f599c8",
  "name" : "Service Manager",
  "description" : "Read and update services beneath a network.",
  "resourceType" : {
    "domain" : "io.netfoundry.network",
    "code" : "network"
  },
  "roleTitle" : "Network Service Manager",
  "authorizationStrategyId" : "3b2a7ab4-c7eb-4adc-bfff-38e02b341fc7",
  "standardRoleTypeId" : "6414ed36-9c20-47e3-9641-ede8630d0287",
  "actions" : [ {
    "resourceActionId" : "e6a7fd89-d2a7-4843-87ef-f2d0a271e798",
    "domain" : "io.netfoundry.network",
    "resourceType" : "service",
    "action" : "read",
    "title" : "Read Service",
    "above" : false,
    "at" : true,
    "below" : true
  }, {
    "resourceActionId" : "85b523f6-4780-42b7-ab26-cd9c82905453",
    "domain" : "io.netfoundry.network",
    "resourceType" : "service",
    "action" : "update",
    "title" : "Update Service",
    "above" : false,
    "at" : true,
    "below" : true
  } ],
  "createdBy" : "16497614-4037-4574-a918-e5f98451823a",
  "createdAt" : "2026-10-22T09:21:25.650678Z",
  "updatedBy" : "a5084e4a-365c-4230-a39a-3651aa614789",
  "updatedAt" : "2026-10-22T09:21:25.689388Z",
  "deletedAt" : null,
  "deletedBy" : null
}

Delete Role Template

DELETE /role-templates/{id}

Authorization

This endpoint requires delete action on the role-template 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

organizationId

String

true

name

String

true

description

String

true

resourceType

Object

true

resourceType.domain

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

resourceType.code

String

true

Must not be null.
Size must be between 1 and 128 inclusive.

roleTitle

String

true

authorizationStrategyId

String

true

standardRoleTypeId

String

true

actions

Array[Object]

true

actions[].resourceActionId

String

true

actions[].domain

String

true

actions[].resourceType

String

true

actions[].action

String

true

actions[].title

String

true

actions[].above

Boolean

true

actions[].at

Boolean

true

actions[].below

Boolean

true

createdBy

String

true

createdAt

String

true

updatedBy

String

true

updatedAt

String

true

deletedAt

String

true

deletedBy

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/role-templates/77c180a0-9a6b-48eb-b96f-5280af2314ad' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRiMzIwNDA3LTgyZTYtNDdmOC1hZTliLWFlNDhlMDc5NjMxYiJ9.eyJqdGkiOiJLRXI4eGRjMTJZUlJ0a2RWckQ0ODBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEzYzM2YWUwLWQ0NjQtNGM4Zi05Y2JjLTJkMThlNzgyOGExNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc5MjY2MDg4NSwiZXhwIjoxNzkyNjY0NDg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcImRmZDcyMTMwLWVkMGEtNGVlNi04ZTkwLWYwNzk0MTNkMGU2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NX0se1wiaWRcIjpcIjQyOGNlYWY1LWRkZDctNGI2YS1iN2YyLTcxZmVmMGQzZDRkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcIjhhNDc5ZjNlLTY5YTktNDg4YS1hYzc5LWNhMjMwMTcwM2UxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1Nn0se1wiaWRcIjpcIjk2ZmM2YjhlLTNhZWQtNDViMS1hM2IyLTcyNjVkNDhjMmZhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImFjNzFjYjZlLTIwNmItNGQ0Yi05MzcxLTUyOTM3NTdiMWVhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX0se1wiaWRcIjpcImZjMjczY2U4LWRkNmEtNDYyZS1hYjIzLTY1NjRmOTA2OWEzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcImZjZjk2M2NlLTE0NDYtNGFhMi04YzMyLWQ4OWU2ZjU2NGIwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4Mn0se1wiaWRcIjpcImNhYjdlOTY1LWE1YzktNGViMC1hOWEzLTk4MDcwMDk5N2RkOFwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg2NH0se1wiaWRcIjpcImNmMTQxNjg1LTgxMWEtNDliMy04MjNkLWY3MTViOTI5NTFmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg1NH0se1wiaWRcIjpcIjRjNjAzMzk4LTFhNzMtNGZhOC1iZTZiLTRmN2E3ZDRlZGRmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc5MjY2MDg4MX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDIxMjkzNmQtODI5MS00MjVmLWEwYzUtY2U4ZTg4ZDYxYTdmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzkyNjYwODg1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.XsEy3aR9eszgbQXUmcMPY0EnCk9ZZ_gkW3msVVZqXQSa_BmrCRPT2HLLXDT-b1A5S_tntAOi-VqCNRDKAzE9GDHAV8_L9NywPyBM4rxkaEk-GYQztrv0oTeTgtmaHPvF-n0XFOFoSSBUDuWRRTiLUq4QRF0FHCD3C3V5kgVDZlZ5QhbT4-F7ac0MTraRS3nlz5vRh_Jmsa4Od3a6qN3OIHzKuy9zO3PPv5tL9xtli0bCYzlHNZ_ZZd3RfvRtcvFLZGWBvySlV7frFeXbrz9DWa6wizb2QhCXr6CdensHTi49-E2JdMNUkAac17KEl-FUMsTiDBGekfoT_Ks1X2Zu_A'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 768

{
  "id" : "77c180a0-9a6b-48eb-b96f-5280af2314ad",
  "organizationId" : "9d38b80b-3030-4595-abf9-2b9ffc1a56ac",
  "name" : "Service Manager",
  "description" : "Read and update services beneath a network.",
  "resourceType" : {
    "domain" : "io.netfoundry.network",
    "code" : "network"
  },
  "roleTitle" : "Network Service Manager",
  "authorizationStrategyId" : "4b745a6e-9985-4e6e-b8f6-f4582975245a",
  "standardRoleTypeId" : "d624a833-750d-4977-9f6e-25fee516946d",
  "actions" : [ ],
  "createdBy" : "da87f646-6865-418b-b7da-6523c16a6764",
  "createdAt" : "2026-10-22T09:21:25.378150Z",
  "updatedBy" : null,
  "updatedAt" : "2026-10-22T09:21:25.406095Z",
  "deletedAt" : "2026-10-22T09:21:25.405891Z",
  "deletedBy" : "13c36ae0-d464-4c8f-9cbc-2d18e7828a15"
}