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

Authorization not required for this request.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

identityId

String

true

Must not be null.

audience

String

true

Must not be empty.
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJ3QnkyT0tZRkt1VGgzRTdaX0JJbXNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQwNjhiNWRmLTdlNzctNGM0ZC05NGE0LWZmOGUyOTZkYjI5NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MCwiZXhwIjoxNzQ0OTA2OTQwLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImYwZTM4NGQ1LWE3NjEtNDdhMS1iZGI5LWQ4Y2JkZTljZThkNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0MH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiOWI3ODE4OWYtNWVhMi00NGY1LWIxZjUtM2Y2MDg3Y2M1ZDhkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzExfSx7XCJpZFwiOlwiN2RmNmE3MWMtYmQ4ZS00ZmIxLTlkNjQtMTYzNzVjYWExMmU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiMzQ1ZDk4MjgtY2NjZC00NGJmLTg3MmUtZTdmODAyMjVkZjNlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYjg5ZjczYWItZTJhOS00ZTZlLWI5YWYtZmM0YTBmOGYyYTVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA5fSx7XCJpZFwiOlwiNWMwZjNkZGUtYmRkNC00NTFiLWEyY2MtNTBmYjIxZWVkNDI1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiODIyMWM5MTctZjk4NC00OWQzLTgxNjAtNmNlYzg4ZjkzMjA1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYmZkY2U4OWQtNzE4NS00N2Q4LTgxMDktNTYyOWE2ZThkODU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzEwfSx7XCJpZFwiOlwiZmVlNWFmM2ItYzkwZS00NjNmLWJkMzEtMWMxOGJiMmExYmUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYzA4NTgxYTAtNDRmZS00N2E4LThjMDQtN2NhNjQyZDBmMGExXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiMDhkOGFkZWEtOGUzMC00NTYyLTg3YWEtNWM1OWU1YmE3YTc0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzIzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Soc4d-ISti3CIkj9bvgpqPNuER-o9hwEkvgZzuOSsZfAPvim3ST8XVJIR5B1UZNfTg29GueLnxRF_4a2m4AKD-SNhexLOJ2nSy-r3sHmKbCLdU5MrbxvcLbRDgkYp8q_hxhZ7g_sin9kQICxpQm6NwK5DuJfL2dgSR6y77uO4sQGwA4qzRXRD36epg41WSzHcSbqeO-uXIo6BYDsqv0GpCcZuc6zSAckWBEqQPk9jxIWMeH-EwShmvkKznFNSe9vIfbvQCK77vF_COFHKBmcORY7FDH74S77qifzOZ5C_RlxG6LaDlpVlwqlqGy8mR5FG0N469DoKmjv9fvAC1NneA' \
    -d '{"identityId":"7fe21e4c-8bf7-4c22-b8cd-43046b842c96","audience":"io.netfoundry.test","claims":{}}'

Example response

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

{
  "token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJnTWhOUUNxcERsWWpJeXJGS1hZTGV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdmZTIxZTRjLThiZjctNGMyMi1iOGNkLTQzMDQ2Yjg0MmM5NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTc0NDkwMzM0MCwiZXhwIjoxNzQ0OTAzNjQwLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjQ1Y2JkMTg3LWYyNTItNDdhMi1iZGU5LTZmMzU2ZDg3OTkyYVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiOWI3ODE4OWYtNWVhMi00NGY1LWIxZjUtM2Y2MDg3Y2M1ZDhkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzExfSx7XCJpZFwiOlwiN2RmNmE3MWMtYmQ4ZS00ZmIxLTlkNjQtMTYzNzVjYWExMmU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiMzQ1ZDk4MjgtY2NjZC00NGJmLTg3MmUtZTdmODAyMjVkZjNlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYjg5ZjczYWItZTJhOS00ZTZlLWI5YWYtZmM0YTBmOGYyYTVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA5fSx7XCJpZFwiOlwiNWMwZjNkZGUtYmRkNC00NTFiLWEyY2MtNTBmYjIxZWVkNDI1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiODIyMWM5MTctZjk4NC00OWQzLTgxNjAtNmNlYzg4ZjkzMjA1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYmZkY2U4OWQtNzE4NS00N2Q4LTgxMDktNTYyOWE2ZThkODU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzEwfSx7XCJpZFwiOlwiZmVlNWFmM2ItYzkwZS00NjNmLWJkMzEtMWMxOGJiMmExYmUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYzA4NTgxYTAtNDRmZS00N2E4LThjMDQtN2NhNjQyZDBmMGExXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiMDhkOGFkZWEtOGUzMC00NTYyLTg3YWEtNWM1OWU1YmE3YTc0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzIzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Bh7cKF6ruSZG0NMqvEPulWkKUkex4xWbUiXeYMeBS_B1U0WrCZYZ8OA7NmA9ExnIg2P0q9-iK43QkRYM5ccseYTRlv8vR8Ap-LTvV9ROjcPoV4GWSkJ4V-bXKSPUc603B2YNkh5b4Ozd4KrIAT0qkJGVgELb_HHK8k0BhZ10B4Z6PpNkiuHHTHIDUk6IB5vTR3a-wpCFPmYyvvQJf3BEejxGcUHKruE74-WcjxVycTGPa5kdpxomCROD5oUhHh1XaQ4gZJlGu2gYoWDa2VXDYqkAfz4vDT-nFClh5G58PjUScP7jBibQLWXR0_WtYxILAa9EZLEcXGTYJ_Y1qsaO2w"
}

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJLam5qVG93NXVZR1hhMzNSVm5CQUF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgxM2NhMGJkLWFiNWQtNDQzMy1iYzAxLTllMDVlNDVlNjYwYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MywiZXhwIjoxNzQ0OTA2OTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTk3YmVmZGQtYmQyNi00ZjdlLWJiYmItOWMyMTRkM2VlM2ZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.eCivodjK752Gl6NhE4NUwL85mBnxHK0fAUhUSOfPfPhy4l1enXb8CPsRhhBFdOGhXmgxbRAoIRvpMXLaKowYFso0zg_iy3_CvvPDFD3NJBdyYLTD3mm5YN_wUVFol22dI-nO-MKG33XPcHEF5ayKkvPh462Ye3r4CRZkmn7aHaN6x1bHQT-bZtdsOlAZtwMXCjGEXKMpnZKeHK5k_9Ydo5glZVgB4LDR2xeGPigMIG-RiAOLfeqLcnwFh2VcLKr6gMmN2u61tqGuhf4ZqPdVL0-t-FyPAfz5n99n496hsOyT4wjVQTWTOTmQ7tRP6qN8mri-kclJkAOOWWxn-HMCPA'

Example response

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

[ {
  "id" : "f77f817c-2a48-49a6-aeab-bc72843170d4",
  "name" : "Test Domain 5",
  "code" : "test.domain.5",
  "createdBy" : "b236dd58-fc64-44a2-a2fd-7cfd9eee4daf",
  "createdAt" : "2025-04-17T15:22:09.356876Z",
  "updatedAt" : "2025-04-17T15:22:09.356876Z",
  "_title" : "Test Domain 5"
}, {
  "id" : "331c1a24-0706-4c32-88a5-c90d676d2d49",
  "name" : "Test Domain 7",
  "code" : "test.domain.7",
  "createdBy" : "524bfa63-77a5-4a84-89aa-0407fede2b3d",
  "createdAt" : "2025-04-17T15:22:09.396084Z",
  "updatedAt" : "2025-04-17T15:22:09.396084Z",
  "_title" : "Test Domain 7"
}, {
  "id" : "b289ebe6-2dd5-47e5-a5ff-dc9571b5f969",
  "name" : "Networks",
  "code" : "io.netfoundry.network",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:47.743518Z",
  "updatedAt" : "2025-04-17T15:21:47.743518Z",
  "_title" : "Networks"
} ]

Get Domain

GET /domains/{idOrCode}

Authorization

This endpoint requires read action on the domain resource type.

Path parameters

Parameter Type Optional Description

idOrCode

String

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

name

String

true

Must not be null.
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/fbca2dd1-4a63-4bf5-be11-9db725e8d520' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJ3ejJIdWsxTW41RGZoWDZZY0VObmZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJhMzgwNTMwLTYyMDYtNDQ3Yi04OTk0LTA3MGE2YjhlMmRiNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MywiZXhwIjoxNzQ0OTA2OTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTdkZWVmZTAtMDFmZS00NjI4LWE2ZGUtNjEzNTVlMDJkMTIwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EykuS9N5PtgOeIduMc1Kqs2mWRbsmq-cX8PVlk2lYB8x6sfkWM1EL1SQ_i7V1cg6iTVKWNJ1ByreLG59-8qYeG7KLgLCBB6ctMqAA-Hfo90Hkj-g6B3tgVk91TX-IR7Fe1pAZYIvCLTdJK3db5Bi-G8CxzOKlJdnTg8HQ0uSjFWaOD84UjOjmLV0s4oS6c0MIwQh6bfRADpiEV87wkPc3sk4OCwK7aAxp_tWgKYG42LmW25VNaquIX5ZMVcZ6VWrue4PBl7sc4Ast4OZh_rZdLFtRNwXAvQ7DlBBwE-78FKksrBCNKeq1kB-4MakeX_snWcFvseF5XtyQ2AjEYMM7w'

Example response

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

{
  "id" : "fbca2dd1-4a63-4bf5-be11-9db725e8d520",
  "name" : "Test Domain",
  "code" : "io.netfoundry.test",
  "createdBy" : "9520a532-0007-4e43-a4f1-1409beaca209",
  "createdAt" : "2025-04-17T15:22:03.358580Z",
  "updatedAt" : "2025-04-17T15:22:03.358580Z",
  "_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJhYnVsejFlNFA5UEJ5WTJ4TVJHdFJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJhOGZjODUzLTk0NmQtNDg2NC1hZDI3LTk4ZDFkYTEyODVkMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MywiZXhwIjoxNzQ0OTA2OTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGI5OWJmYjgtOGRlYi00ODE5LThmOTctOTBjZTMzNDgwZGQ1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.J9dsHDvELC0Pwdu5PSnmbgo8A1QJugFRuJTeagNwSsSvizrehAbaw8szlHj59MwhxRuBmef6vRSmq_98pv1LDu9IwNAyD9hliomlQJUce_JD9FMI_VI3axxnhiDZRO2c_JuSQuX9swkliFezGW25f9NdXJepM4dLXxDVudxOR8bYHtr-h0dL_NaJ8K8HfmlYihPUFQNwktX1HCjb46FDkm560dlhiHDGXTha13R5rcxL3j1q5cTDhO0n9a2Eg0Ov_WVVuNkDBp3NOmP2lD28xTfAhJ0q8wMbEytSBWDUmsU3tzujw9n0caLCmVYRd9pl2yXeGbxYYRzie2xC5yL8hg'

Example response

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

{
  "id" : "fbca2dd1-4a63-4bf5-be11-9db725e8d520",
  "name" : "Test Domain",
  "code" : "io.netfoundry.test",
  "createdBy" : "9520a532-0007-4e43-a4f1-1409beaca209",
  "createdAt" : "2025-04-17T15:22:03.358580Z",
  "updatedAt" : "2025-04-17T15:22:03.358580Z",
  "_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJOSnBkLXptMkRIM1lSOHU3N3hUQ1pRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM5NWY1M2E0LWU2NDMtNDYzZi04MmI1LTBkY2U1MmZhYWJkYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MywiZXhwIjoxNzQ0OTA2OTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzdjMDVjM2MtOTdkNC00NWUxLWE0N2UtN2RhOTg3ZTk5MmJmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.nTdARU-20K-jc2G24mf4Jw-7hnnG0_rd8Ed53S5Xv2pbntLOkEMRCubuBrMtEpkkYxXLk-0Y0xj3too4xADHSrR_Z7KJl2X4nfw1ksAzQYS6uQHEEerqZjnRMgkcNyqrXq3EFnHODWcuelaPWX_PDenrz755Oe2LPU37BlJHQSiNJRPBcRmJFhK-sdIAC8yDz8k5yNNWgeZJ1CKn2sn3kmvRWvRuf-0AckJiuMuCrzftSyWkntfH6y6yulWSYavFgiaW_Xc2rlDXg6SG1NRkQub8uuqwTN1p4L0ct9UlUlaecBFQXml0d-LSQxX_KyOyprBMFxdRBsjRf03vO9okJw' \
    -d '{"name":"Other Test Domain","code":"other.test.domain"}'

Example response

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

{
  "id" : "f04378de-df2c-45d8-aa05-ab2f30968c98",
  "name" : "Other Test Domain",
  "code" : "other.test.domain",
  "createdBy" : "c95f53a4-e643-463f-82b5-0dce52faabda",
  "createdAt" : "2025-04-17T15:22:23.876227Z",
  "updatedAt" : "2025-04-17T15:22:23.876227Z",
  "_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJEa2RNS3ZTWEJ6dENDWUVVODlsaXRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRjNGEwNjNiLTFlY2EtNGE0OC1hOGIwLThhMjMyMzZkNWUyMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NSwiZXhwIjoxNzQ0OTA2OTQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzk2NTUxOTEtNWQ2ZC00YmYxLWEzYjctNDU0ZjZjYjhmZmY3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.b9M5x55LoL6gscBEMvCdpsrHqrQFqbIZtC7_dmky1-G_170VcBI5JvBCM20FiZfjPEoK8KGEZBGJHDpD-7W_GIPWklFU3eIyaRb6pjuIFroIkUa-liYiENR72eA_C-yb0LQC8hVxuJaa_Zwyt4S9LC-TgdEratcRg5aSUQmWNHd5q2eygIEU61kVp2W-csNxtteAytfJ_rfBic5GV2kB7flz9WkoG2jDCpClw5LszCDNTU5fQ_vpGCgCTWQ4mQJT2UCrq1-5CLmwnKyAfisbQFcqZtJbWJqYx5Fs143a_Zm6gxx11DzDGxvD95FBiKvBc1-jHObTfHoV8YsvtSe1jA'

Example response

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

[ {
  "id" : "109641c5-6aaa-4f98-8901-6111bd73e7cd",
  "domainId" : "b289ebe6-2dd5-47e5-a5ff-dc9571b5f969",
  "name" : "Network Version",
  "code" : "network-version",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:50.085011Z",
  "updatedAt" : "2025-04-17T15:21:50.085011Z",
  "parentId" : null,
  "root" : true,
  "depth" : 0,
  "childrenIds" : [ ],
  "_title" : "Network Version"
}, {
  "id" : "89d8eaf5-1ada-46a2-95ec-79b46a279d96",
  "domainId" : "b289ebe6-2dd5-47e5-a5ff-dc9571b5f969",
  "name" : "Geo Region",
  "code" : "geo-region",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:47.745595Z",
  "updatedAt" : "2025-04-17T15:21:47.745595Z",
  "parentId" : null,
  "root" : true,
  "depth" : 0,
  "childrenIds" : [ ],
  "_title" : "Geo Region"
}, {
  "id" : "d953c504-980f-40b3-9d60-26eb9bd6cb52",
  "domainId" : "b289ebe6-2dd5-47e5-a5ff-dc9571b5f969",
  "name" : "Data Center",
  "code" : "data-center",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:47.745595Z",
  "updatedAt" : "2025-04-17T15:21:47.745595Z",
  "parentId" : null,
  "root" : true,
  "depth" : 0,
  "childrenIds" : [ ],
  "_title" : "Data Center"
} ]

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/baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJicVlndDZVTTFmZTVFNXBMMi1jbUlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY1NDBlYjA3LThlMGQtNDliYS05MmQ4LWI2MDJmZTE1YjljNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NSwiZXhwIjoxNzQ0OTA2OTQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOWUxMGQyNDktYTcwNi00OGE0LThhMGItZmIzNjQ5M2YyZTU5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.MCU_6m_SNT6WWTfk0OC8DF-A-5-mLGypbbuuWM0krPFnRgjbdFtzNAsZQIsGJZzv1RzcTxh85P5NiqBBp0vMlmtWK_Sm-2bey_s77g53t_bZSXK69pILHGSaAVEFmoXQ9MJjULI1iZ8OiE4Pj7rSUJXGBQGl-_lN5KFXmPmE-pABXGal7wvnMeXN7DFPeIBUugDV7czNfFEGCi5ky2U70EzuCqDMRY0aNjSvNLt7EBE3LsqiK7ZoULwpSsbguzR0FNv84zeit33g5LYZCRwneWvBF8EqqBHsztep44520APQhgEYXqgbT_7ge2FTfdSr0FRuhNCxzrvBJ21KK4dTUw'

Example response

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

{
  "id" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59",
  "domainId" : "fbca2dd1-4a63-4bf5-be11-9db725e8d520",
  "name" : "Test Type",
  "code" : "test-type",
  "createdBy" : "520aa60d-f68d-4fc6-849a-28da930b1155",
  "createdAt" : "2025-04-17T15:22:03.436726Z",
  "updatedAt" : "2025-04-17T15:22:03.436726Z",
  "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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiI3VHBzN1ZMX3JLbHVRUlo0a2ZGckhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU5ZWVkMmNlLTQ4NDUtNDI4YS05ZGI0LTZjMGNmMzJhMTkwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NiwiZXhwIjoxNzQ0OTA2OTQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjgzZDU4MWQtYjYzMi00Zjg1LTkyNTctYzA0NDFmODcyY2RlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ2fSx7XCJpZFwiOlwiYjIyMjVhNTAtOTk4My00ZDJjLWE4ZmEtZDQwNjRmYmIyNTZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ2fSx7XCJpZFwiOlwiODgyNDEwZTMtYmI2Yi00YTk2LTg4NDItMjU1ODRiYjQyOWZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.m9ORUhsUcb0EJENRNafBv8xGkDKXYPv9Ax99uSC-r7Px41d4B-S7XlfZBfPek7smEOTXxmzyIQ-PKadel7EKeDcYPDrBUR4AQdxkVWdJvOIz2DJP7vUpwCPugZ7KJnQA1eIoHnsm2UqjuM_kX4iL7eUy1BfhQkhwR0ngmh5Yul5ZfVtYilRdXYMxXOsniisb7h0ZJCx01Mul8nBW4t1TMAagzYGDUj9l14QL6zfUtmOk0d6zeP9NS0g1WeuB2boOWirBT46pQDTPVV9G_NYOGh5-pUbxl8sC2T2tQKmoY4ozO13Q6hpjz6eA_89Jl7jkGN-uV2fFKA_4UyIMTpb-nQ' \
    -d '{"domainId":"fbca2dd1-4a63-4bf5-be11-9db725e8d520","parentId":"baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59","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" : "591369eb-189c-4694-a92e-9a05fac23c19",
  "domainId" : "fbca2dd1-4a63-4bf5-be11-9db725e8d520",
  "name" : "Another Test Type",
  "code" : "anoter-test-type",
  "createdBy" : "59eed2ce-4845-428a-9db4-6c0cf32a190d",
  "createdAt" : "2025-04-17T15:22:26.170652Z",
  "updatedAt" : "2025-04-17T15:22:26.170652Z",
  "parentId" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59",
  "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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiIzX0xDb0NOTEgyTkx4WVpRUlV6YWh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ5ZWQ4YjJhLWUyYTAtNDcxOS1hY2E2LTkwZGEwMDA2Y2M3NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NSwiZXhwIjoxNzQ0OTA2OTQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTY4NWY5ODktYTI5Yy00Yjk4LWE5MzUtNGMwMzNhYjg4ZTc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.AjeILMnsjcmygRxQCv8sv9yJG8Tk7fkJH7dxT1kVDCMBoGEWzXoOEbiRasJ-_CZX_WeaoCpua29QMNVJpJr6ufZjyAE4UUIOoQNPTe43dwgybD9V6abkDXeaO04tY62WA7xYANoomqOlmu3NPEO3ftX2tX_UqJHTVr3PT5IrvfHhQ1hlH91wUnz2D8J06UQoYrb5ZAh7Ah5iAV2GsGh6SH7OKs7lUbAgXJRRN1oZgmPTz5XH0rE4UKFqeV4ardQUrzLiYc3UepNz81DaA0K1fCjQY-RY_rwH0vNqETP88Bvtczuh0ZNASniuy6egqBiVmdy35nxCkSMGGnG8gXp2lg'

Example response

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

[ {
  "id" : "5bf4dae8-a213-4433-85ae-26127bc3b598",
  "resourceTypeId" : "6ff73b7f-7d69-40a7-9086-b58a7ec8e752",
  "name" : "Update",
  "code" : "update",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:48.936342Z",
  "updatedAt" : "2025-04-17T15:21:48.936342Z",
  "standardAction" : true,
  "_title" : "Update Edge Router"
}, {
  "id" : "01848f2d-ccb2-417a-af18-4b81bf9eb50f",
  "resourceTypeId" : "5a24fe2b-c721-4f4d-9ca7-c1873eca4cc3",
  "name" : "Update",
  "code" : "update",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:51.455721Z",
  "updatedAt" : "2025-04-17T15:21:51.455721Z",
  "standardAction" : true,
  "_title" : "Update Browzer App"
}, {
  "id" : "4cb5bacb-9ff9-4a33-8031-1aa56b070bd7",
  "resourceTypeId" : "012827b2-006e-4d69-b4e1-023d9b41b29e",
  "name" : "Update",
  "code" : "update",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:49.814231Z",
  "updatedAt" : "2025-04-17T15:21:49.814231Z",
  "standardAction" : true,
  "_title" : "Update Posture Check"
} ]

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/3e4a750a-7bc4-46a9-817e-2e8d2d48da71' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJNQXMtRlZabFNxTzFsbFRBUzUtMnBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU3MmQ1NWM1LTNhYzEtNDUxZC1hOWQzLTVlNmNmNzg0NDNkNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NSwiZXhwIjoxNzQ0OTA2OTQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTJhMjQxODItOGM2OC00ZDVkLTlkMDAtZTZlMGRjNzBjMjVkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ce0Kj9KsPEpPficYr8LG_n2oYM5IB6eQTsJ95ICSl-jOI4PRaFyzmi8E3_S3MLzXOpZkF16fSM0jqCPGxnsrPTc8ErKmS42Jth_QzUpLQZhFTVjyX3G1skwITiMvPNT_hN7j8HQlOE350Fg2TpVM1gA8p9BlHXD1-uKZDKn2bUp_5ior1ZO_aimVPlhdu5idPwUwU9NMV8tUkDP3bpgSgz_YT-NNeQFTfqZjPBFamTWfAbqr4_OKwpdQTWspqpudKutTZ8Ti2nCnJGU6APbxxpZHKLvdH3scuIsuVi9buYDiOZ8jJuoxOPCRUcgQvr9R8PVmYua0EPDCcUcwiNZ7VQ'

Example response

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

{
  "id" : "3e4a750a-7bc4-46a9-817e-2e8d2d48da71",
  "resourceTypeId" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59",
  "name" : "Test Action",
  "code" : "test-action",
  "createdBy" : "932ebf31-e9e6-4c7e-8c9c-b8d9740d8158",
  "createdAt" : "2025-04-17T15:22:03.478695Z",
  "updatedAt" : "2025-04-17T15:22:03.478695Z",
  "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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJxQ0YxMW56UWNUMFlZb3NPTGgyeXFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY5ZmQzM2E2LTNjY2QtNGQzMS1hN2M2LTdmYTgzNWIxM2I3YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NSwiZXhwIjoxNzQ0OTA2OTQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWM3NjIwNWMtMmZmNi00Mjg0LTk3NzUtZmFhMWEwOWQ0YTQzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fSx7XCJpZFwiOlwiZGU5YmI3NWUtNWVjZi00Y2MxLWJkOTEtNDY1MWY4N2JlZmZiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.K71zU_BYSJt9KGn39aVgB5_spuYkVKPmGXzFwJiNo5bdkqrKZZ0u2evihPNguUuZlfmw8LPFah4c34Kp5EB0VKGZfLmb1_x6SvsIEtPgFV7i-3TGuu0YTquC8OpoVKOHB2g06dv9lMwpTg5qTgMbbi8NKzFdcyRPNIZRBskImUHPSkjn2YE9-aBsMmdXhYdlkLpaS7rNlJ2pMFMBiaOtlQ-zV1aZHTBHu5MRS7ICtIXhFY2lL1SQDTpH1kO3MK8k0I1mrWoRfmwAqWFXE2TsUNo5PXInoxLCmmHTQqXihfKFDurYMrtzU8xrM1WInr74DYDStzYXfT69n3KGfUI3zg' \
    -d '{"resourceTypeId":"baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59","actions":[{"name":"Update Custom","code":"update-custom"}]}'

Example response

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

[ {
  "id" : "933b75d4-80ee-4912-86e9-0adbec25fd54",
  "resourceTypeId" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59",
  "name" : "Update Custom",
  "code" : "update-custom",
  "createdBy" : "f9fd33a6-3ccd-4d31-a7c6-7fa835b13b7b",
  "createdAt" : "2025-04-17T15:22:25.433954Z",
  "updatedAt" : "2025-04-17T15:22:25.433954Z",
  "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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiI2LTJmMzJDYmxWMWh6dU5TMXpOcVJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjExNDc1M2M2LWQ3ODYtNDJmMi05NTNkLTczNWE3NzUxMjgwYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NCwiZXhwIjoxNzQ0OTA2OTQ0LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjM2NWEzOWJhLWJkMDUtNGJkYy04ZTM3LTU2YWY5YTNlNTU0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiOWI3ODE4OWYtNWVhMi00NGY1LWIxZjUtM2Y2MDg3Y2M1ZDhkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzExfSx7XCJpZFwiOlwiN2RmNmE3MWMtYmQ4ZS00ZmIxLTlkNjQtMTYzNzVjYWExMmU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiMzQ1ZDk4MjgtY2NjZC00NGJmLTg3MmUtZTdmODAyMjVkZjNlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYjg5ZjczYWItZTJhOS00ZTZlLWI5YWYtZmM0YTBmOGYyYTVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA5fSx7XCJpZFwiOlwiNWMwZjNkZGUtYmRkNC00NTFiLWEyY2MtNTBmYjIxZWVkNDI1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiODIyMWM5MTctZjk4NC00OWQzLTgxNjAtNmNlYzg4ZjkzMjA1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYmZkY2U4OWQtNzE4NS00N2Q4LTgxMDktNTYyOWE2ZThkODU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzEwfSx7XCJpZFwiOlwiZmVlNWFmM2ItYzkwZS00NjNmLWJkMzEtMWMxOGJiMmExYmUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiYzA4NTgxYTAtNDRmZS00N2E4LThjMDQtN2NhNjQyZDBmMGExXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzA4fSx7XCJpZFwiOlwiMDhkOGFkZWEtOGUzMC00NTYyLTg3YWEtNWM1OWU1YmE3YTc0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzIzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.HliZ42t4qOT5V0Agwb1XmQxrdaYkU-CBeRUd7_hhI0ePvs4Jvhvf_P1s0gx92YcJIwzW3j09Mmz_qPpg-CEC8ckokJAUlF_9KWKIwHJXeEEpKaQnPDEFR6vXM9OAQ8A46JVq3fmSftAN3GS4CjL_leBHE6oSl-WGzSGoXfZd_Pt85lf5VoK3LnXn9KxD5rnxIxq2Vv3m8Uq_iReeqpcjGQAJ0HBizCtYITYEA49aynMr7xgm7TZMxEqMvoXZAygvmxS5fGi31k6b4cyPB8aappRMQVW1O8j4VE3prE1neHKJ39Zwnx3HYNBi0WfcXv7XV0_66zAc0rHCnq71Xlp7sw'

Example response

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

[ {
  "grantType" : "IdentityResourceAction",
  "grantId" : "04ce0c0c-d631-4f1f-b86c-c06070bdd304",
  "privilegeSourceId" : "04ce0c0c-d631-4f1f-b86c-c06070bdd304",
  "identityId" : "0ed768fa-7214-4404-8335-a715156dff45",
  "privileges" : {
    "io.netfoundry.auth" : {
      "public-grant" : {
        "read" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:50.011383Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read Public Grant, All to identity 0ed768fa-7214-4404-8335-a715156dff45"
}, {
  "grantType" : "IdentityResourceAction",
  "grantId" : "bd15e55d-c9ff-450e-974d-253b91af63f8",
  "privilegeSourceId" : "bd15e55d-c9ff-450e-974d-253b91af63f8",
  "identityId" : "0ed768fa-7214-4404-8335-a715156dff45",
  "privileges" : {
    "io.netfoundry.network" : {
      "geo-region" : {
        "read" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:50.011383Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read Geo Region, All to identity 0ed768fa-7214-4404-8335-a715156dff45"
}, {
  "grantType" : "IdentityResourceAction",
  "grantId" : "2995623b-31af-4c9e-b7f4-c234b401132f",
  "privilegeSourceId" : "2995623b-31af-4c9e-b7f4-c234b401132f",
  "identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
  "privileges" : {
    "io.netfoundry.billing" : {
      "account" : {
        "read" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:51.185912Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read Billing Account, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
} ]

Super-User Grants

Find Super Users

GET /super-users

Authorization

This endpoint requires read action on the super-user resource type.

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

identityId

Object

true

domainId

Object

true

isDeleted

Boolean

true

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].identityId

String

true

Must not be null.

[].domainId

String

true

[].createdBy

String

true

Must not be null.

[].createdAt

String

true

Must not be null.

[].updatedAt

String

true

Must not be null.

[].deletedAt

String

true

[].deletedBy

String

true

[].type

String

true

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/super-users' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJnanA4cVJWTExtRXoxU2d2ZnZtU0hRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ5MmQyYWIxLTEzNTItNDI2Zi1iYjRlLTIxNzAwNGUwZWRlMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0OCwiZXhwIjoxNzQ0OTA2OTQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmEyMTQ0MWEtMzRhZi00M2M0LTlhNmItNGNlYThhYzBmNWJhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ChpVuo6HkP0j_6LX5oZBvbQiGxLscJI7R8hkO0_T2_-nZ5JkamDyuRFPd-N8d6nsEHXaJQOtVNhx8CDZj9zK-lVYJ41Xujspxqr6dqsq4xTBI0TzKCR1KtE1HV_wr37MJgTU6w2ENhOjOM5TGOyRWUmh1E8ByYO4FdZRA8CljH59Tz6Ekz8qyOT9Js5zm4zRS4fYkwn4GQC_BUNrh0cIOCsULc025B7O57jisGx5toPnNPhyUzfuSszIgbxPkgTvHe8nKoSMAu5gdCIrgWL_PYIFqkPs3A8ZZT_Jnad3oL7ULoQvd-KkCyNoWnz7jz3Yde04ept9dyIhmAaRv08vxg'

Example response

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

[ {
  "id" : "99924da2-bc67-46b7-9a59-466bfba1a9ab",
  "identityId" : "7fe21e4c-8bf7-4c22-b8cd-43046b842c96",
  "domainId" : null,
  "createdBy" : "5b02daa1-becc-4696-bfde-aa8bea45c898",
  "createdAt" : "2025-04-17T15:22:27.979136Z",
  "updatedAt" : "2025-04-17T15:22:27.979136Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 7fe21e4c-8bf7-4c22-b8cd-43046b842c96"
}, {
  "id" : "8363ae75-fdcd-4d1f-955e-f4648ec8b8d3",
  "identityId" : "e771cdc2-8eca-4d49-8a33-bd7b83d93910",
  "domainId" : "2c828719-c52d-4f1a-b4b6-2326a5002bd8",
  "createdBy" : "ba1dbd18-5ec3-4ade-923c-7dca1f69063f",
  "createdAt" : "2025-04-17T15:22:28.117931Z",
  "updatedAt" : "2025-04-17T15:22:28.147909Z",
  "deletedAt" : "2025-04-17T15:22:28.147271Z",
  "deletedBy" : "1dad84b4-617b-45a5-9981-e20ec4c403e9",
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in Test Domain 68 to identity e771cdc2-8eca-4d49-8a33-bd7b83d93910"
}, {
  "id" : "365a39ba-bd05-4bdc-8e37-56af9a3e554b",
  "identityId" : "114753c6-d786-42f2-953d-735a7751280a",
  "domainId" : null,
  "createdBy" : "954a5da3-7265-444b-803e-182613229811",
  "createdAt" : "2025-04-17T15:22:24.006335Z",
  "updatedAt" : "2025-04-17T15:22:24.006335Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 114753c6-d786-42f2-953d-735a7751280a"
} ]

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/45cbd187-f252-47a2-bde9-6f356d87992a' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiI5aWU3QUQ3eVBlSm94ZnJhRlJUbEtRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjMjgxZmIyLTAwYmMtNDk0ZS1iMGRkLWFlYzI2YjIyMGZlNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0OCwiZXhwIjoxNzQ0OTA2OTQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjIyOWQ3ZjUtZjJhYi00ODExLWEzMzctZTE2YzBjOWMyY2UyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.UXTZ47qzuFldJSg1fB5-Sffceq5O3Kq7FyidBfquSKvzbdskXIjgAYOCzb_F1xV-DJ2aiFJ0J1waymdqSZ9puqdO1YrI6mDbcBx6MVsvAW2RsoBhjWXd5FWXCKjDPJK1CDjVqL0EM2lJ1To-5W53GV3E-dEeG_kmN7_6wsG7-T8295bqb1GSnWRHga4PuJCWS6_Ylkm_TloaKgFr4dOGOCubwqa6NKL7j1_r6maoKzKyOiFd_wfTWVzbsiAlhxQ8pOmudry2au04P4qCPeDwWiWLVyxIYobEpT-gQSM9k8nA4CTINSn1DtzrAf91WAGDrW9KO559im72NRCdQFb9Cw'

Example response

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

{
  "id" : "45cbd187-f252-47a2-bde9-6f356d87992a",
  "identityId" : "7fe21e4c-8bf7-4c22-b8cd-43046b842c96",
  "domainId" : "fbca2dd1-4a63-4bf5-be11-9db725e8d520",
  "createdBy" : "ce527d07-3762-4125-8fbe-f883fbc4e10b",
  "createdAt" : "2025-04-17T15:22:03.509424Z",
  "updatedAt" : "2025-04-17T15:22:03.509424Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in Test Domain to identity 7fe21e4c-8bf7-4c22-b8cd-43046b842c96"
}

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJuNi1qSTZWazY5OXlTSU1pRHF3OUN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjViMDJkYWExLWJlY2MtNDY5Ni1iZmRlLWFhOGJlYTQ1Yzg5OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NywiZXhwIjoxNzQ0OTA2OTQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGU4ODZiY2YtNGQzZS00ZDYzLTgyOWUtZTViMDY5OGMxNzZiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fSx7XCJpZFwiOlwiMzk5MWM4N2MtZmI3Ni00MWVlLWExNzItZDI4ZDNkYzczZTllXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.dsHlxzw9f9gb5hc7yB1YPjN2Yv3Dywaw3Hhm8RjwDy2EB-WQg71Nk5fcR0VGYroKAv89OZDiG8L5CkGGcVYClC-7JanZjn0o2xLqQGL2JdltwTf7nsr3lfWUz-monCfLrn-QDKPy2U9oksTSNZ3qqlCgg87bBbGv68AkDbTb2VMhJagZ2bbB3TcRCN5Rv26WR9G4tBeXcoVmw1jS15hWgPgQK2NaqP1CMZtLBPeIK3uAz598JHAzm1UYTDjWMEHvueAJXRemNRAHzKA6aAREPYmGb4o-v4C8CEO3lnGCLY8R5Qe0-Gn-MSNcE7BNJBjuOwCqKUb7s0qgFrgXm4Femw' \
    -d '{"identityId":"7fe21e4c-8bf7-4c22-b8cd-43046b842c96","domainId":null}'

Example response

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

{
  "id" : "99924da2-bc67-46b7-9a59-466bfba1a9ab",
  "identityId" : "7fe21e4c-8bf7-4c22-b8cd-43046b842c96",
  "domainId" : null,
  "createdBy" : "5b02daa1-becc-4696-bfde-aa8bea45c898",
  "createdAt" : "2025-04-17T15:22:27.979136Z",
  "updatedAt" : "2025-04-17T15:22:27.979136Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 7fe21e4c-8bf7-4c22-b8cd-43046b842c96"
}

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/8363ae75-fdcd-4d1f-955e-f4648ec8b8d3' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJuN2F6MVA3bmFJdkVFS0xBU2VpY0t3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFkYWQ4NGI0LTYxN2ItNDVhNS05OTgxLWUyMGVjNGM0MDNlOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0OCwiZXhwIjoxNzQ0OTA2OTQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmM0NWM3N2MtNzc1Mi00NTg3LThhYmItMzU5Mzk1Yjc4MTUwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EH5fFjgJgiqRqfzaDDwM153tA1K5LGqjpq4dBU2PCSgcRqVb-zRODNDEMTsCM1y5AGYZxRbFoqp-mkc14LVKb_o_Op8mwPRpXUFm-C46F_MQ6EHLCp4dvxBmtRpYf-LwqGTVDad6ADNtiwZnO9_5NzMuvIeUSqHEI9918mUbngbpqB2myTbkG9HzM3xfyDjjali0N-zvEKeZpmrd-ZH-PcYwZaYnubLcv11y9xsj-l2pCWHA4loucZmJTIgZhcPZaUiHKCFGI8z5SNPBJctsKdALTzr-5t6pes9KYF88s4UKLUgPXhp_TTmO6yXElMwJ2AuoTOqiwZM-3LOqmoo3mQ'

Example response

HTTP/1.1 200 OK

Public Grants

Find Public Grants

GET /public-grants

Authorization

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

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

resourceActionId

Object

true

isAnonymous

Boolean

true

path

Object

true

isDeleted

Boolean

true

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].resourceActionId

String

true

Must not be null.

[].createdBy

String

true

Must not be null.

[].createdAt

String

true

Must not be null.

[].updatedAt

String

true

Must not be null.

[].deletedAt

String

true

[].deletedBy

String

true

[].path

Array[Object]

true

Must not be null.

[].path[].resourceId

String

true

Must not be null.

[].path[].resourceTypeId

String

true

[].anonymous

Boolean

true

[].type

String

true

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJ5aGhteTd4ZHpVeVZiM2xWM1JqMFRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE5YmUxMjIwLTAwNzUtNDMxMy04NjJhLWViMmM2OTRlZDYyNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NSwiZXhwIjoxNzQ0OTA2OTQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjgyMTAyZTEtMGNkYi00NjU4LWEzMzctYTIxNGRkNjgyNzQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ipMyEKFOG9zbF_9wQey01IzJ1XTfImUk3PKbD4q9465_P5oHkRJiCMD1-rHO6u6n2NH6E-ugZNWaY4NKCTo4YI8DmIgMow4TRC-nYEa31KDWOXsq-4liWCVco_iDVI3esy8-WGYXC5nqAA7SEvNUpX7R7zTG76oCzzVwxuOum5OuL5OvaA8lggw42hx7BYHBO8khT6AZI6vac508tH09qbZKKPT7_k__Xuka5r39OVli67HVHe4RfW1uYaOeIAnuWonAmGBZ2BzWyeKGqxlK9urAqeyYJSbwofypl1BezXnW-nh7c6_UK7wet6YlHCjQJLh3hRF8mx_urM_VJznB6w'

Example response

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

[ {
  "id" : "08d8adea-8e30-4562-87aa-5c59e5ba7a74",
  "resourceActionId" : "3e4a750a-7bc4-46a9-817e-2e8d2d48da71",
  "createdBy" : "54c902ae-e5e7-4927-8f48-db70b6d092c9",
  "createdAt" : "2025-04-17T15:22:03.537414Z",
  "updatedAt" : "2025-04-17T15:22:03.537414Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "38a38c63-7c85-4260-944f-f72ba2c22a17",
    "resourceTypeId" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59"
  } ],
  "anonymous" : true,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Test Action Test Type on/under Test Type 38a38c63-7c85-4260-944f-f72ba2c22a17 to All Clients (including anonymous)"
}, {
  "id" : "345d9828-cccd-44bf-872e-e7f80225df3e",
  "resourceActionId" : "69bcb2e4-641a-4479-ab4a-e36b36bfa186",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:48.481188Z",
  "updatedAt" : "2025-04-17T15:21:48.481188Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Read Resource Action, All to All Authenticated Clients"
}, {
  "id" : "7df6a71c-bd8e-4fb1-9d64-16375caa12e7",
  "resourceActionId" : "7825df11-4e99-4ec3-9ae0-0ab3e59ffd9b",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:48.107932Z",
  "updatedAt" : "2025-04-17T15:21:48.107932Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Read Data Center, All to All Authenticated Clients"
} ]

Get Public Grant

GET /public-grants/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

resourceActionId

String

true

Must not be null.

createdBy

String

true

Must not be null.

createdAt

String

true

Must not be null.

updatedAt

String

true

Must not be null.

deletedAt

String

true

deletedBy

String

true

path

Array[Object]

true

Must not be null.

path[].resourceId

String

true

Must not be null.

path[].resourceTypeId

String

true

anonymous

Boolean

true

type

String

true

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/8145c7af-7d6a-46d1-af62-2675766cc36b' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJPRjVIQ0lwRE84ZGpyUG9vcDlBS0JnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI5ZWE3M2EyLTgzOTAtNDVlMS1iODQ0LTZjMzdlMjY3NTUxMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NCwiZXhwIjoxNzQ0OTA2OTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2Q1NTlkZDgtMGYxOC00YzlkLTg3NGYtZWVlYjNhOTE0Yzk4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.B-0l3fsfqNuMsx-YxcoRj22ic_OzYz-hRfgNviVFO6Wiu3bTjVcY-yu3D5262v_Qv5yZuVJgGHuswHwPItRugREQ5y6Uf3GSsGUwBQNzu0m9B4NOLJ7WKOC5ecJb0q6TDX7HQtYZbhw0KAyTJodDt8rR9Cu-u0IZaQNhmTEErXkHzxKN2fDQNH6SVx6WvEZXGmMzeKHqHWn4Pxt99OwgtYdCRoq28GdgocbaWIxi9TIGb2psp3jLeMEeOE-v9bs5_sF5lFYFtmERa4vBESPiDX0YNj0NiUat93ctYa7-urWkMKftQc3LrPOYSnQhGQnm58Wc-P1MURYgiznSw9pltg'

Example response

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

{
  "id" : "8145c7af-7d6a-46d1-af62-2675766cc36b",
  "resourceActionId" : "08eea132-e7e8-4892-849c-db3f6cd0c768",
  "createdBy" : "2b6b9108-770a-461f-887e-f79de06538b7",
  "createdAt" : "2025-04-17T15:22:24.930921Z",
  "updatedAt" : "2025-04-17T15:22:24.930921Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "a63a0b8c-2d57-444a-99f2-cc29338bcb80",
    "resourceTypeId" : "d7c1de88-770f-49b1-a1da-f26d1f1b5e98"
  } ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Test Action 46 Test Type 45 on/under Test Type 45 a63a0b8c-2d57-444a-99f2-cc29338bcb80 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

anonymous

Boolean

true

type

String

true

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJRX0xkaDhLcm1aTkU2elBnZFRmT2NRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQwZTlmMjUwLTZkNjctNDBmOS04YTM3LWUxZGQ2YjJmZmFmMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NSwiZXhwIjoxNzQ0OTA2OTQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDIxYWNlOTEtZjNmYi00ZjFkLWJjZTQtOGM2Y2MxMDJjNmU4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fSx7XCJpZFwiOlwiNDE2NTMxOTctMWFmNS00ZWRlLTk2NmEtMmJkYzZjMjkzZTUzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.iwBIuozFQcqojGwM9_7GwVgw40lzAFNHocyiVbJhnTAoHGyc15kzZvGAO4vhBqqXfyCcAlPaF9TuqVlMh232wDwhlLFmsHKj8Nl4xKEthYYjSO5-YXK-5Zd4qaIZxcuGD7tlDB-k_aiT3Mc2iz7qRY4KGk4y6qeduWxzQHVwCk4XjK0iB214x2breaTqyKFort7CNjaHOxKI4_tFwUGtXS1U9dBpZ-olykQ6dA3Ii4XTr-M1wzGLPEFFO4NCqbpQQM9m2xaBkF36is51gV1CMFdyglqZdg3CSPwZ0c-OewuGN8yFeenSGlmE1AQT5-qzZDtOUG-gi6dlMMiAuN7Ytg' \
    -d '{"resourceActionId":"3e4a750a-7bc4-46a9-817e-2e8d2d48da71","path":[{"resourceId":"77cfbd6e-ccd2-4d98-9f25-af7175d261b8","resourceTypeId":"baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59"}],"anonymous":false}'

Example response

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

{
  "id" : "77b0d28b-f0fb-44ed-bc26-12efbd4f18a0",
  "resourceActionId" : "3e4a750a-7bc4-46a9-817e-2e8d2d48da71",
  "createdBy" : "40e9f250-6d67-40f9-8a37-e1dd6b2ffaf3",
  "createdAt" : "2025-04-17T15:22:25.199212Z",
  "updatedAt" : "2025-04-17T15:22:25.199212Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "77cfbd6e-ccd2-4d98-9f25-af7175d261b8",
    "resourceTypeId" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59"
  } ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Test Action Test Type on/under Test Type 77cfbd6e-ccd2-4d98-9f25-af7175d261b8 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/ab45725f-f209-47df-a945-7713b9cb4f48' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiItNkpxOUNnSkc1UGk0X0dlMjU1UG1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY1MzQ5MDAzLTkwYjEtNDQxOS04OWYwLTNhYTRhZmMyZDI1MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NSwiZXhwIjoxNzQ0OTA2OTQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImFiNDU3MjVmLWYyMDktNDdkZi1hOTQ1LTc3MTNiOWNiNGY0OFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTg3MTRjZTAtYWZlZC00NzFkLWIzMGMtNmFmNTIwMDdjYjlmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.VivNE3jWzwUW2jpjPemXJITDqcO_3sJyBhcg29OXJOb6hb7R8HJWcYWsREJSfTliOncOQuzjC9Iiug6Nekols9sI_PIBIWXOyVGbjfQiO7IElgXGmIHdSm693_GqwrtJ67i7XwLkDYtT_GshSUIDtCOkfWdpdxVowepNX5U5WX5k8FkMuP9DnRiVKzjU_Mwo-8-bbiSniK39ah2t9kxCqupLhNWJYTaigaxe8eY6RlG98m4MWTFAMtKbCxoVC22GCoTGc4e6Z4erk5OOyXOGmYuvxIGMt-F_GxAscyxoAG_puZtCV3X_jQknMialpnk3JOUg5JsNPklQms11LB-QUQ'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJmUmc2VE1WUjZ5TUlzNXVZaTU4ODZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVkMTUyMTBkLTFhYTItNGZlOS1iMGQ2LTc5NzU5NGE3OGZlYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NCwiZXhwIjoxNzQ0OTA2OTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTI1OTk0NzgtYWVmNy00YWUxLThiYTAtNmY4NTdkZjA0ZTM3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.k7j848ZhVOsK68grHJ6maqRAXr8GsdogrinBGCkImsUEb0qG2BhkUVihWdW5z7LTHJtGsF-uWWVs2MkWTZn5JKXjS_j7G0eoUDeWvXtY6BMD4jex3RLoZYi7Mn3IdyZrvJoy88KZcYKridyCoAhKTPQYegaHJVa7ARhtX82r8hHjooXbFiA6F7lULuELrhV1enfkwLkJ9i2usS_flcYawKyLLVxh9Ru2vJJY06KOOY3vwKNByfdCIKhbdDbyYmlHZtCnVNqQ-V7eweBFtZMvIbluJxQZXsu-KvbaeQZNi8s8-OnF_S__fxY0rvdXlUJvMVgpoYfNA6xSVmIooe87EA'

Example response

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

[ {
  "id" : "0e58dad0-9c2c-4c97-8fbf-bafe559358bf",
  "identityId" : "83d8cce9-1ad2-4ec1-ae23-9d1f3d28f2ba",
  "resourceActionId" : "7d3a6c39-b8ba-4d10-a781-5b6babd1375f",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:48.747444Z",
  "updatedAt" : "2025-04-17T15:21:48.747444Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Read AppWan, All to identity 83d8cce9-1ad2-4ec1-ae23-9d1f3d28f2ba"
}, {
  "id" : "fb628a20-a1b2-4932-8b58-e1bd0cb331fe",
  "identityId" : "0ed768fa-7214-4404-8335-a715156dff45",
  "resourceActionId" : "69bcb2e4-641a-4479-ab4a-e36b36bfa186",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:50.011383Z",
  "updatedAt" : "2025-04-17T15:21:50.011383Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Read Resource Action, All to identity 0ed768fa-7214-4404-8335-a715156dff45"
}, {
  "id" : "a6db7d2e-a8cc-4496-ad70-311de131b253",
  "identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "resourceActionId" : "4bac482b-78bd-4ad9-b00a-d0e3a5a34c03",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:51.667774Z",
  "updatedAt" : "2025-04-17T15:21:51.667774Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Read Root Certificate, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
} ]

Get Identity Resource Action

GET /identity-resource-actions/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

identityId

String

true

Must not be null.

resourceActionId

String

true

Must not be null.

createdBy

String

true

Must not be null.

createdAt

String

true

Must not be null.

updatedAt

String

true

Must not be null.

deletedAt

String

true

deletedBy

String

true

path

Array[Object]

true

Must not be null.

path[].resourceId

String

true

Must not be null.

path[].resourceTypeId

String

true

type

String

true

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/identity-resource-actions/68ef5d9b-e9c5-4c1d-84ae-a0ba469e7b98' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJmSTQ3ajl2cnNLYUV1UWFFbWxIam9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVmMmY2ZTA2LWJiZjYtNGEyMS04Y2RkLTQzOTliN2M5YjgxYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NCwiZXhwIjoxNzQ0OTA2OTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjQ0YzI5ZmYtOTkwMC00NWZiLWIzYzAtY2FmN2ZmOGQ2ZThjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.nFq6k2ach2gJaOp-CUPw_5FfpZWe-VZaQBg8BCIRvU-GRUJzxOCuPUbr60gfwdkzmwUmtr5i5_skh-71BYJW0Zdc7HZPIDxyMKqxdTtqrDoHvPhz9ffYEQybPOeNw7A6jofMY8zcp4TUUn6riWUgLF9byvXlgJV9PdF1uFFRRTdOLVaoKphkasQsWEEhO_HkFxaOOV8g5B6OWMlw2enWj_hxmpGpJkPDz_oB1JmUewq7mHtBfVjICW4x9dYV0YpsFJi08ULanDWaq8Mtz-utP_pdRuNq9clG1Kkr9DUOaBDXoVWcvkkkizKTlWl3PZPzrs-1PSmmgCc2DPBcj_p-9g'

Example response

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

{
  "id" : "68ef5d9b-e9c5-4c1d-84ae-a0ba469e7b98",
  "identityId" : "41922542-204e-4081-9103-79d98c281beb",
  "resourceActionId" : "8d8c9965-c875-4dc7-b8c8-593fc58ea01f",
  "createdBy" : "a57dc83b-deba-46fe-b783-e0fec626cebf",
  "createdAt" : "2025-04-17T15:22:24.637522Z",
  "updatedAt" : "2025-04-17T15:22:24.637522Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "27acace8-b75a-4f82-9d7e-09af331505ef",
    "resourceTypeId" : "3547b618-34ce-4fcc-b799-ff60ee6cfee2"
  } ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Test Action 43 Test Type 42 on/under Test Type 42 27acace8-b75a-4f82-9d7e-09af331505ef to identity 41922542-204e-4081-9103-79d98c281beb"
}

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiIzbVI5LW5TOC1zR2F0X1V5ekljUmp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQzZTMxMWFkLThlOGQtNGYwYy1iMjgzLWE2YTc5NTMzNjlmOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NCwiZXhwIjoxNzQ0OTA2OTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODIyN2IxZWItYzBkMC00N2RhLWJmMjQtZWI5YzliNDQ4M2I5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ0fSx7XCJpZFwiOlwiZWY0NGQyZmMtN2NjYS00YzdhLTg3OGEtNGY1ZjY0MzUzMmU3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.SEwNWdC4RKbNkAu6lboZel0m1_I-Y5PPUMLy0VVYusEGDqHkexTzWL2V_LhmlKB824wFEQMZUTs0HbUQyxoCjBr_ssBOGH25T8yhprDTyvGKVRZoyCnOsvsDVzAT1SQdX5FfNkRMnCC9t-Sphr7nsmOPoanZxWA62MnzyAWz2feBq6xO1E-xKx6Z4hhTNd4NHvqlcag5lTSnd1UaXso6TOCPuuFKs18JaCXSO7HU7KVXwyrF6wSfWwfldiUzrvMpYZSJTfwWjZsDIoUdxm-Fo34e2PL8OrZBPzP2vTQs5yaFr6OTiltLhF2nb72M1ofTIgwE_2iJAS3ZONa14odC-Q' \
    -d '{"identityId":"112adfab-9a05-49a2-9bf2-475e2958512c","resourceActionId":"3e4a750a-7bc4-46a9-817e-2e8d2d48da71","path":[{"resourceId":"0b3532e6-c522-4f70-a662-e0f6436bbef9","resourceTypeId":"baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59"}]}'

Example response

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

{
  "id" : "425a8ed3-c87e-45a5-9fe3-94931205518d",
  "identityId" : "112adfab-9a05-49a2-9bf2-475e2958512c",
  "resourceActionId" : "3e4a750a-7bc4-46a9-817e-2e8d2d48da71",
  "createdBy" : "43e311ad-8e8d-4f0c-b283-a6a7953369f9",
  "createdAt" : "2025-04-17T15:22:24.790467Z",
  "updatedAt" : "2025-04-17T15:22:24.790467Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "0b3532e6-c522-4f70-a662-e0f6436bbef9",
    "resourceTypeId" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59"
  } ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Test Action Test Type on/under Test Type 0b3532e6-c522-4f70-a662-e0f6436bbef9 to identity 112adfab-9a05-49a2-9bf2-475e2958512c"
}

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/a1467c13-3041-4d24-a804-f97f6c26cfdb' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJuVGNSZzJTbUpXVFVRNkVZbmM2S3F3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJhMDI2NjYxLThjNzctNDMwYS05MzU4LTAyYzA0NTA2OWFmMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NCwiZXhwIjoxNzQ0OTA2OTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzc0OGVlMTMtYzkzNi00ZGNiLTkwZTAtYjM1YTNkYjY1ZmM4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PyMVpL3baT-4h2BRNKSNfpkSHwvIZvRXr00stxNsK3NUhaRPXYOq-r_ZqLf8ykm6kevKf1QmYlU5R_0L_H27XdZXje1qfx3kETShzH6yOQBAMbhSbrBrf4Tf97lCmHVzikLpqtWM3S8PGrsnlhmyvnf7Ng2Ae60Si3zd7w6o9Jv5DSfU9fhG-zkkALKDxeTHVibRJjaw8abASC8n6B_tFlbVCHOgF8Fkdacyi3Uv-y27xAMw8yNqzFemPYKpllt2htLuDV4lDpTLJB8ltOIrJ-aQm0eNuK6C9P5GhqzNu9Y352ZPIkfRhRCRa4bnA7ClS3kmv4WthNEf1W696gUJKA'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiI1aVk4UFBnN1FTaDRka3Z3RDRHQkp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZkNzVkZGY3LTNmNDItNGU0OC1hYWY2LTk4ZTU0YjgwYWIyYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MiwiZXhwIjoxNzQ0OTA2OTQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTRjODBlZTItYWIzZC00NmM4LTg0MDktMDViY2NmMjIyZjlmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZFy3hW4ToNGkbefuMaFhdjo2RE4p_WTw1CEDvp009xrNTi4dtI9u0RB2eIyGfKHI8s2Qo72S0b_YjyNoe-l_WqNQqfM_R_g1bvpsaOk01IhkWyjqxG4kTUoaFJSbNUcYiofoplfEReJ6gVpgBhaA4BM65EZpwqey1V0tPB_8FvBL0_0YWP3baPuXveGLSbF8gVFj8Bf_1s_NwhHL8ca2ogV0KWhDiB9t4zG3FPklFrVYzJ-H0ukO9kBwIsfgzKP1Me69HVTnGpNrw9s3E1Xi4jQe4MylEDSbmQDDdPug_NhoPTIaB2EyyHhBWyDGniMAmBPDJE6nQ_2o0jHhZ_MK_w'

Example response

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

[ {
  "id" : "f1e3d5d9-2899-4df7-89ab-297d29cc54bc",
  "name" : "NF Support - Observation",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:51.839269Z",
  "updatedAt" : "2025-04-17T15:21:51.839269Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "NF Support - Observation"
}, {
  "id" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
  "name" : "NF Support - Intervention",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:51.839050Z",
  "updatedAt" : "2025-04-17T15:21:51.839050Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "NF Support - Intervention"
}, {
  "id" : "9f39940a-0d28-46e3-abe0-086c389efc47",
  "name" : "Test Custom Role 27",
  "createdBy" : "1d7ceb3f-39c3-4365-a053-a30e585a9d70",
  "createdAt" : "2025-04-17T15:22:21.499564Z",
  "updatedAt" : "2025-04-17T15:22:21.499564Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "Test Custom Role 27"
} ]

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/a32bf15b-9691-440f-aa13-c5da696522bc' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJDYjBOOGg3WS16UXcyb29JamlmZFhnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJmMDMxZTBjLTgyNWQtNGRhNy05ZGEyLThmODljODgwZDYyMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MSwiZXhwIjoxNzQ0OTA2OTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2M2NTljYTctNGRhOS00NTBjLTlkYzUtM2M2NDIxM2ZhNTJmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.m8pZhsYqmtHhkcJdVtcOUykzWRNjkEOpQSXU6o2ZJhzHORKozs2NwpcPeUnFy-6LCXSzEmPM8W8cVTKh5XEalp4a9Yt2V18fAW2N9aE8ToUdea2lxRDJUqdGiwCaFga8DgHTatPELOIn3nSslmHRQmKlT6dzd5M5_MCK-MXof8Z4TsKten_H-EU14w7NhAKw6dwwVYJNo5ZFLuGIvSZchDgTUR3DZum76nGTkA6XhkockOyikl2rqiibiEW9E2LGg7LdP-ZXIVaL8-GAXU1u0touq0nbSNA4ql2c-iVnVFlLEoark3t6EezFVjEKj6XXIXPPoesdwKpPygZB79RVng'

Example response

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

{
  "id" : "a32bf15b-9691-440f-aa13-c5da696522bc",
  "name" : "Test Custom Role 31",
  "createdBy" : "5bec0064-5424-4094-8ac4-43ef394cc3c3",
  "createdAt" : "2025-04-17T15:22:21.777439Z",
  "updatedAt" : "2025-04-17T15:22:21.777439Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "Test Custom Role 31"
}

Create Custom Role

POST /custom-roles

Authorization

This endpoint requires create action on the custom-role resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

Must not be null.
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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJFbHMzdVFNWERpMkYtLVo4eGNFYV93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFmZmZkMzM4LTg3OTAtNDc1My1iMzgzLTMwZTQ2NWFkOGMwNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MiwiZXhwIjoxNzQ0OTA2OTQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDI0MmU4YzItNWM2OS00MmM2LWE5OWYtNzhiYzE4NGE1MTBkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.cWevhjNxMqYv3QTZvwJKNZqDaZDiI79cH_uJHCRkAUhOqwdQmsVdRrdbPJ2jPIWSNzjPd56tH-7-Lxd0uYvgiiKwr1KMtWcxu6HJl2zYF8AJnr1lYbEprl7ArgaCwSiRLboH9SR16ACtowGKmOvFcaFs5UGx_yf7huC6o2vxlQl18rdwlZyJDXTHXUnxHgcKcm1XTTL16yn9uUQHxWWpy30-QchjvHHTT4-kMsI4yu5slxfhhvkx0xEZ19PZds79lgY0JtAT9uIbLf1DtM7bE7eyappK8mLFfFzbLrUK-l0Ud4Dqyi-RXlEzmauus9CBfEb01ouv5reWg1-yNTPKFg' \
    -d '{"name":"Test Custom Role Create"}'

Example response

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

{
  "id" : "eb1c85ea-22e4-45fc-b5b5-df954a40982f",
  "name" : "Test Custom Role Create",
  "createdBy" : "1fffd338-8790-4753-b383-30e465ad8c07",
  "createdAt" : "2025-04-17T15:22:22.613357Z",
  "updatedAt" : "2025-04-17T15:22:22.613357Z",
  "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/86b45d8a-2e2c-48c2-af1d-04b60d0c5a60' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJnenFCZlUzZWRyU29vODRyYTA2NVNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ2MzQ4MTk1LTYyMzUtNDcwZi1hNjRjLWQ0MzJlYTJmZjdkMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MiwiZXhwIjoxNzQ0OTA2OTQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmJhMmVmOTctMmMyMC00MjcwLWE3NzYtZGRkOGY0NTdmMzkyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.R2-jg0IM7BjKG32g7LMoLibFQZisVBHhvO-5clzUAWfuhE4hFXUSQLwcmZV49j-AEBWV3WSwha0CRaBX0mbitq-lXIyNSM2O7HkCqlVTTtc1NRQl6OtqOeqvLqZrEm_Mhk57VfCdxcQU-0NnqTEMvYbRuj9q6sOAF57wo38S-PRWI6gtgmyMaqaTDT5TONVNQs2juKjQov_QIdysqzLJ1QSReWFirV2bZzzyAtC0vid8zewDlZ57OTydESbesBNu0yelglyhtu5_31CL-C8v3gwt6Y-6s_3w1_tT7ljjZPftKxmYRqXvsrTIusTAo687wAJxLBjUFVK7MBNoYJY4TA'

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/ee1e2870-9921-4474-b200-79266fc9bf6b/identity-grants/29f6cabc-3041-4e45-94c2-264200441ca8' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJuZFN1OVAxaDZRajFvX3h3Mmtrbk9RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVlMDljNzhiLTZmMzUtNGE4Zi04ODNhLTJhZWZkMjc5YzVjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MiwiZXhwIjoxNzQ0OTA2OTQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGYxYjllYjktODRmYy00ZjA4LThmYjUtNTU3ZjQ4ZDc1ZGQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQyfSx7XCJpZFwiOlwiNjEwNWZkNDMtM2ZlZi00MjUzLWIyMjYtMWE4ODM5MTI3ZTBlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.iyq5shQ5vmKNSvfh7_DVROIdmKJa7pKpvlThfkJHL34Xi_yCXZAIIffqx9Cz4EyUUhZlrMsHtC26dmijH-FjbEiT5FrBfqPShogSa3AzDWhbN1HOIj8UWSxXYGzeX1NV02hTcU3TuA1b4NGYeeQI8IgA5hKOgel7EWeicdg4cWiDNoTUaTM-So1LiJ0xSr6BVf4jgr1Svq1tfzSvJH0tosUW_1Ob5lAKf5uRQpahNgqf_u0jybDcvDL91Hq1lX1IYvkR-hITHW-G0EBwxmBOrR-SFlZDsTiydrbxae0A6Xfl3YtzTZfcR9O0ddJxCAxFJobn5GSh0PmJG75S5Yxrkw'

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/d99c9813-50a3-4649-b839-6432cbcdf799/identity-grants/5bbf6df5-805e-4303-a034-95b57df97ba3' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJlM1JwSlN6MEZVNWhnUjRBWUNoVFJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYwNDcwYmYyLTAxMGUtNDcwYy1hYmFjLWRiNGVhNjBjZGU5ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MiwiZXhwIjoxNzQ0OTA2OTQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTVlN2ZiZTctOWFlNS00NmQ2LWFhYTktMmIzNjI1Y2E1YTk0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQyfSx7XCJpZFwiOlwiOWUzMWVjMWQtNzAyMC00YWU3LTgyNGQtMDVhYWI2N2RhN2Y0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GzFIZqyJNckCxbIK5AdfblOJ4a6m3aUACXl5ChJXG4lo22TOkgVP4NphxAnOuFBwaPgpRVOTsg2b4VN1Y2IIw87BBQRUBp5eTt1mRr06AP_kO-E4EzbrXOAmoItlC61LGLN44M7q7j2lRi_vaqGPz6-EngaeYXmhG7Rd5V5UzKwJNFaHlUSV9eUZ6JP_TVhw0iLFp9lnGdyiaGdsAbkpjLM5jcbY3YSuDIM81oYhnri90JsOrdI2lEQFSVS2ONFJ2DnMxdxkS2jujlDPAKHDBxQJBko5a-NHbt2uZ-1RBv3sROiymqRlDep09watbWE92pmz7OVoQ94WNu07t_9jxg'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJwMTBlSkN6ek9zUE1id1dPdEpYc1BnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk1YzFiODVhLWE5MjktNDViYi04Zjc5LTkxMTExMGE2Yzc0ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MSwiZXhwIjoxNzQ0OTA2OTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGQ3ODgyZDQtOGU0ZS00OWNmLWFjNWItMmNiMWI2ZTI1YTRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GFWBKJtWORY13pa8MGvPs72sVKHnJS71jwtLzjkaedC6rZoR830z3p8To2Sjq32GnV4tszxqLtJMuYmGx9Lliv4-KTXJ_1NuhhCgH_RNusKbfkDRuV2bWLiXImItcM0T_WLKzbS70evviqhJKImx5nMkNK4v_j5I3___yPDjqlD6Q1s1fs7f0JX9td8X9N1lKSWMdnNHQOWpkG8fvGG95v7JlaFdr8fdqXcVcnuL2CmA_wwz83i9FKsyzEtqxK2btaQ3vbYvj9NPmd0fVLLdRT3-pWzHcZzfm8snF-lv4QTYmsaduRtaNBCfYsqIDj9KSunCAIVoYtvhAkTRVL3FgQ'

Example response

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

[ {
  "id" : "f43a7197-d3a9-4321-a532-20e9dbd69ba5",
  "customRoleId" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
  "resourceActionId" : "c934aa8b-36a8-4d8b-aa40-67055e7b7b83",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:48.725829Z",
  "updatedAt" : "2025-04-17T15:21:48.725829Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Read As Code AppWan, All"
}, {
  "id" : "ef30da26-8298-457f-9a42-36de0d526164",
  "customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
  "resourceActionId" : "d794ed8f-5a5d-4489-8acb-1fb6ebc7bcc9",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:52.141058Z",
  "updatedAt" : "2025-04-17T15:21:52.141058Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Update Resume Network, All"
}, {
  "id" : "39d7f332-06e7-49b5-8c6f-ff507ea7351c",
  "customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
  "resourceActionId" : "f1c8185a-5b5b-46b8-9ab7-4312bda654ca",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:52.472611Z",
  "updatedAt" : "2025-04-17T15:21:52.472611Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Delete Attribute Mapping Config, 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/7a9ff0f5-0e66-4d5c-8fb4-b0e5c620505b' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiI0b1lUdUVWeHNYV3gwRjhac3dKd21RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk3OTA2ZTMzLTE5ZjAtNDdmZi1iMDNhLTMwOWRjMDRiMWE0YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MCwiZXhwIjoxNzQ0OTA2OTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWJjYjFmYTQtNDhhMi00NGM3LWJiYjctZGNmZDY1MzRiNzkxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IliXKMEeW9dxYKjy3WipXct24UW39BcOOK7KAAugEpHk7jpYa4POvuaHcgqY8i6tiqvSvdr8Vav_Z32MHKirapjHwYEKsMM8o-VuOk94jTuEGp-1aOB16CfFRi1nx_HzoXGKX5_96yxPUZQ2FIX32WmTaFL1h9T_LzY4CQ0rtinBJgIIEnBjbEkmwmHkbFSLvopTFjVGnbHUkjQUUa9kAjIjnk6ZiqTLn8ImXUhOJZhl_TGs1yPbp2bDblhT6aVN3I-_kjCaM19RrMdusVkvfTlgZlmNOMWKzdts-hpIAiWLhbS1k92tnRinUudjgKQHvO1nP4v_E59efqH8Jkz1ng'

Example response

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

{
  "id" : "7a9ff0f5-0e66-4d5c-8fb4-b0e5c620505b",
  "customRoleId" : "66045465-7a68-4f98-b16b-9391b0dc5711",
  "resourceActionId" : "927266ab-95d5-4330-a614-e6bc537dcddc",
  "createdBy" : "b87e2830-5e5f-4ce5-a14a-2886fc066570",
  "createdAt" : "2025-04-17T15:22:20.830473Z",
  "updatedAt" : "2025-04-17T15:22:20.830473Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "773b6f12-7934-4fc0-b817-6633f62afa69",
    "resourceTypeId" : "cb8d8ad8-fd96-4ee6-9a12-dc917b05ee30"
  } ],
  "_title" : "Test Action 26 Test Type 25 on/under Test Type 25 773b6f12-7934-4fc0-b817-6633f62afa69"
}

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJFMUx1cGl6YmF4LUVRTUpJZ21majZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhjNzhiMzcxLTljM2ItNDdkOC04NTg0LWNmYmU2MjFhOTA3OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MCwiZXhwIjoxNzQ0OTA2OTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzJlODc1YjQtOTMyZi00NjBmLTgxMDYtYzhjOTVjMzRkNTE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQwfSx7XCJpZFwiOlwiMmIxMTI5OWUtNGZiNS00NDc3LWEyNGMtZjA3MjhhM2RiNTJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQwfSx7XCJpZFwiOlwiODIyY2QwMWUtNTgwZC00NjAzLTlhYzktMTFjN2FmNzM1YTE0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.FEfJFEcOsmq3fesro6KREisHvbcJSsXoePJjbdT17hBGZnfT-6cZ1sKtbW-yzw07Y6SkLKLKN8VIgv6kesfzx0j4GDRzB5JoPJY24Khr8RcG7iTRiwJfiI3vLRaPcPGYMQ7PeSK37hf5mer3cgluKB0G1yjZ_sx6mr4U7lpI392UTSg-51wZ0HSP-AmkLnpNhFSCPnGa6-4L3DPHqzb3nzeEvvkRVBCbmQgMR9OZQDH71vABYCVnu_S-0bm-COLFUKOHMH432orgoJ4hXLDBiIltzSbbuH1zZpf8sKOIu3r-PCjZFz6ipEVPHIX0xnGU0mBz0zdcj4fKRx-lFehjXw' \
    -d '{"customRoleId":"f34ea84d-828f-4087-b7d1-b9ddb3d62985","resourceActionId":"3e4a750a-7bc4-46a9-817e-2e8d2d48da71","path":[{"resourceId":"e8a57f18-92fd-4bea-884b-f1a8fca1e428","resourceTypeId":"baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59"}]}'

Example response

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

{
  "id" : "888ead5b-2ba5-4a8b-af9f-f2d10cc347ec",
  "customRoleId" : "f34ea84d-828f-4087-b7d1-b9ddb3d62985",
  "resourceActionId" : "3e4a750a-7bc4-46a9-817e-2e8d2d48da71",
  "createdBy" : "8c78b371-9c3b-47d8-8584-cfbe621a9078",
  "createdAt" : "2025-04-17T15:22:20.679071Z",
  "updatedAt" : "2025-04-17T15:22:20.679071Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "e8a57f18-92fd-4bea-884b-f1a8fca1e428",
    "resourceTypeId" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59"
  } ],
  "_title" : "Test Action Test Type on/under Test Type e8a57f18-92fd-4bea-884b-f1a8fca1e428"
}

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/a63820b7-a60c-4ccf-881e-183c94ab43c5' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJFOEFqdHRmenZaWWZTbVA2ajFmekFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMzMzFkNDMwLTYyNmQtNDE1Yy05OTA2LTcyZjBmOGJmMjNjMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MSwiZXhwIjoxNzQ0OTA2OTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWVjNGE4MmEtZTU3My00ZjliLWEwNjgtOTViYzU0MzNmMzkzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Y9lUkfzr8VMF0SqF6fHK-9DQCoT_QV1qsJMGGy6jzQXDZ2zCJgu9NVyadBnF7ImnRUSK7y_j8LDpngO_4Nh_HaPCTpqfEgyLIuPxTN6ZX68NoxeID4DapvCkf-XBe8ZO_ozJ8SNcgrBai5Nf8JF8MwTdmtbIBTN8xUcI4bmt-BUeNY12n6WnBMqS8JwxGDS2LA5-4Z4uQennl9sQNppH2i0BHtCcXNhDOoPh12xk66xBantgtRo3jeahmEV48PI2nSk-I6Awx7AR2mnSmHfmAsmvJsYlkhEtz1Kt8jD3rqOy7bE5Vwkm-zmrAzosIW4cQIn0vOaNItYuBt_i9YqcUA'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJpdWxudVZ0dHNYejZfVnE3MjJMd013IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI4MGIzODFmLWYyYjYtNGY5ZC1iMjhlLTllMGU5NmEzNzcxMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MywiZXhwIjoxNzQ0OTA2OTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjMwYWM1NWMtYjAzZS00Y2NjLWJjYjMtNTJmM2NkMWUyYTk5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.aBkqrT4FUAGZCyELBRxrlaGaWJwOrquBjbRtwcVW7pYbm-z8CfjNok2qdzRVCC_mrvwlYwVU1raUnmH-Qz2sNcyDGD2GY2picuZkNwy8nnVG1QKPfmDJfdz9RNZJ_1oXx8wrHUF2r2AhcYa30TOepxf-0F4fMD8LzP4GbF4aoyS6QmL6bn0G5GuK-ERqyLxUSyR0litYltqy7N2-vxqoVkDYiKhtOa4wKer7UiDCrnuAWKpGLRqWiFgqnk_UGAkSs8rye8Kcpb2SASpFXiBhW1j0YOC8rge43WBIMViMLnJEuQ65MwfZaWCdQJPjHAQVmu5H-6te3DO-JEhWbfYrmA'

Example response

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

[ {
  "id" : "80b7d2d2-2445-423d-83f4-f13a087f093d",
  "identityId" : "bc186704-9a24-4c84-a5f5-a756a17a67e0",
  "customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:48.492056Z",
  "updatedAt" : "2025-04-17T15:21:48.492056Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read-Only, ALL Auth Domain Resources to identity bc186704-9a24-4c84-a5f5-a756a17a67e0"
}, {
  "id" : "01a69ec1-639d-424d-85f3-175bb046d0f1",
  "identityId" : "4b0c906f-2915-4786-a783-66ec832c1e9b",
  "customRoleId" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:51.034684Z",
  "updatedAt" : "2025-04-17T15:21:51.034684Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant NF Support (Read-Only) to identity 4b0c906f-2915-4786-a783-66ec832c1e9b"
}, {
  "id" : "1cb29ccc-cd89-43d6-a5c9-f6774dcd6b04",
  "identityId" : "373cef0b-d1d8-460a-9aaa-373a63556a5f",
  "customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:49.474786Z",
  "updatedAt" : "2025-04-17T15:21:49.474786Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 373cef0b-d1d8-460a-9aaa-373a63556a5f"
} ]

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/45ac0150-b5f4-4c46-8661-82512eabb60c' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJjbElyNGw1Y0JQaDVVbUwxZ29mNEFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVkZjg3ZjY3LTI2MjQtNDYzMi1hNmVhLWY0MmJiMTAxYzY0YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MywiZXhwIjoxNzQ0OTA2OTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDdiNDdhNGItYWViYS00NTRkLWIxNzYtOGE2MzhmNmFlZjdkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.QvKSnTMYl_9U8LSz81SGBmEUaUfOTrrFoDTo7eVkVTGR0KLicBTwKkEC6iXYyQpKbDC80WI9XybvOFZOWzXR3DGoN38A6znx6DREyExCMj4aXl75gHANlrSkn2Tka6VO5lhcH99WoxeVSGPXnE8fqY6SUdCWvaA1fGA3BSbGKUZrxpn7f2dmazJWeqn75cpF3tpRgZFyKrSIoMSsAAFpDu0-KrtwFe4i5t5Sr_vca8ip6k8b-fQx8TeQ54LQBN1lvnjXS2DXjT8TU2ABSFSvCwUQQV0NFOV38SPIl5wE5_8toVXcahip6gfNakTqe9UAzcyAczonYy3NYI-Nr2ENTA'

Example response

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

{
  "id" : "45ac0150-b5f4-4c46-8661-82512eabb60c",
  "identityId" : "bbe5bd66-3e83-4435-a0a5-35d6b0773ac2",
  "customRoleId" : "6473ed04-41e4-42d6-88cb-f4dac9f4250f",
  "createdBy" : "a2fa9931-3355-4878-9c01-e92e1b23b177",
  "createdAt" : "2025-04-17T15:22:22.996258Z",
  "updatedAt" : "2025-04-17T15:22:22.996258Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Custom Role 35 to identity bbe5bd66-3e83-4435-a0a5-35d6b0773ac2"
}

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJJcXdGa3gyRVhCQmpCQjBLaHJxSzR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdkNTNiMzUwLTA3MjktNDczZC04N2JlLWJkNGYxMzM0ZGYxYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MywiZXhwIjoxNzQ0OTA2OTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGM2MDIwZDUtOGQzYy00ZDQxLTkyNGMtYWRlNDQ1OTcwMGJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfSx7XCJpZFwiOlwiYWEzYjQzNjItMDQzMS00NWI2LTljMTYtZWRiZmU2ODZmNTRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.nYBmFtYArecIX2k-d_VQ3qibk9dy79-_VlTzufGvanERVJb7YwQY6t5sZEyKVP3AaVo6PIwWcAy8RQ99Us9pUvqeFfOvYVPfsN916qyeTBCOS6acFyy6zg3hTgRjM-TyM6DKeFCz5w-PBP_2lMGp_wLtG_Q1Xm_RXgBxlC490280Yh9w-XNvVYwjRW0GsRxqJPIktx93ouBG8RCE3WSjTSEcV164_vUxmqxjkYAF7YH8zPD4WaU199b1cFujIceaLuJ0_79I-_ZN9sjbAC33jZaBXBqRDo0KrjVpM5p19DKSjHbihPenZrdLflvVj60z7SxixZgARK9X4abIO9XBQg' \
    -d '{"customRoleId":"fd572909-7eaf-4ee4-a31a-2e13edcbc48b","identityId":"c9fb601d-bf6b-4eeb-a850-ba78007effe5"}'

Example response

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

{
  "id" : "8e063b9c-f4e5-4830-9842-aff1101ec96e",
  "identityId" : "c9fb601d-bf6b-4eeb-a850-ba78007effe5",
  "customRoleId" : "fd572909-7eaf-4ee4-a31a-2e13edcbc48b",
  "createdBy" : "7d53b350-0729-473d-87be-bd4f1334df1b",
  "createdAt" : "2025-04-17T15:22:23.239068Z",
  "updatedAt" : "2025-04-17T15:22:23.239068Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Custom Role 37 to identity c9fb601d-bf6b-4eeb-a850-ba78007effe5"
}

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/ac8b2143-c83d-4c03-b453-b38944181388' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJDakRnbDZUSEpqQVU3YnJrOWdFYk1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUyYTA1ZTY5LThjNzctNDQzMS1iOWM5LWRkNWUyNDI5Y2I4OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0MywiZXhwIjoxNzQ0OTA2OTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGVmYjNmNzQtMDQ1MS00NDVhLWFlNzYtOWNlMjI4MDBjYzk0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.GXqfj2v-Mee7CIVUVjeBe3Kilwn3N231A0NYBGzCqoaMpOKSTUqAFXGoHNoaSn86LpUMZW9U6cUrWPptubKR9odUotCqG4f5BHbEbd-7FzcDuIxUQEkADcCdJ5fpogFFmj-HNRvC2IxhNPwoeNPTvQNnC3bfGtVaBWzmMdSiWKYGUUs--OljPWoV4iJoj38YqJ16xhziaMqhUUjWd2YwAPKxbSsaRDpbmP6d-WdZIPmNnbYZsTtLdRunkOxits3W1iXfgp-iZtdQUEmFcV8F_xMLh_QaYBgmAnQFMOP1DktiZlsp4flV4ESDkfk3nuVUoPhF4ov3DExsncvBUIK21Q'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJ2RmdLUjUtS09VdVE4UktFX2UyOE1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ3OTUyOWM2LTRhOTktNGI2My04MjYyLTcyMmI0MGNhZGVmMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NiwiZXhwIjoxNzQ0OTA2OTQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDI0NDI1MTktYjZhOS00YzVlLThlYjAtNmMzYTYxNWI4N2I0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DitQE8RCqfeuMxBFIVKLc2nL16avCm7lSoYmHituPYb4gdvgL0DwV7rOxAbD6H_LTqSFfJrcUAzM43-oIYVzxIo7JI-Oi5bgFPzXrm9pm6vsxffdWlvT-gcw5uy9626IyFqBHwGs9ucZMzga_wiHf5ZqQ8CVTdxXdUR0u_W0qF8-sXJbKMCLE2x2uUQsS8lliwUveS7exedOHfGU6LXQfA-nwr1jTaW88AO8j0Pfaqm1zQlU8aczt-H7e_wQ0DLsu_voIsvslf2rgH7crYtQq6WeZJYeYQfQ_PriNQgDFm8yFWRdvhgk5p3oIB8YrzNm5NPVCmTcKSh9HVoOmZyeyA'

Example response

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

[ {
  "id" : "ddd39147-0ce2-473d-93c7-25b1b404433d",
  "standardRoleTypeId" : "5841175f-5f71-47f0-a711-86f0fc73199f",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:51.916159Z",
  "updatedAt" : "2025-04-17T15:21:51.916159Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "3c5d8b2e-4349-44a3-b5ad-ecd30cfdb5dc",
    "resourceTypeId" : "859ae9c9-8228-42d6-833c-95ba2cdd89e4"
  }, {
    "resourceId" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
    "resourceTypeId" : "23bacd58-ef4b-44d8-b1bc-43bf70f0d884"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Standard Role Admin - cf53e966-a3ad-4e80-a5fc-380fe8d48e57"
}, {
  "id" : "2854b8f9-6538-11ea-98de-128b2daaf7e4",
  "standardRoleTypeId" : "5841175f-5f71-47f0-a711-86f0fc73199f",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:52.038835Z",
  "updatedAt" : "2025-04-17T15:21:52.038835Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "3c5d8b2e-4349-44a3-b5ad-ecd30cfdb5dc",
    "resourceTypeId" : "859ae9c9-8228-42d6-833c-95ba2cdd89e4"
  }, {
    "resourceId" : "b75be358-a3f9-40a5-972d-a804c4758041",
    "resourceTypeId" : "23bacd58-ef4b-44d8-b1bc-43bf70f0d884"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Standard Role Admin - b75be358-a3f9-40a5-972d-a804c4758041"
}, {
  "id" : "4922e85f-aa4b-4b4e-8031-3a632ba53a51",
  "standardRoleTypeId" : "57f7d4e3-7b6b-4885-8eba-4f2c8b7a4a38",
  "createdBy" : "a3a6eff4-f584-4426-9d35-a97a8e930a26",
  "createdAt" : "2025-04-17T15:22:26.547892Z",
  "updatedAt" : "2025-04-17T15:22:26.547892Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "70440d5c-c4d8-4fca-928a-ac018b5d9721",
    "resourceTypeId" : "2652474b-988f-409f-a61f-e6eb27a70135"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 53 Admin - 70440d5c-c4d8-4fca-928a-ac018b5d9721"
} ]

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/4922e85f-aa4b-4b4e-8031-3a632ba53a51' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJ3VjFLb2ZvZGxVeVF1bVc4MWI5M1ZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjYmU1MWM3LTg3ZmEtNDk5Zi05MDg0LTAxY2QyNDU5ZDZmMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NiwiZXhwIjoxNzQ0OTA2OTQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDNlNjZmMGMtMjI4My00M2JlLTlhM2ItMjM0YTZkODRkNmQ0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.CiTTYPxLKdUnUiL5S7AMr_31XgeeaKlD0hdajsfx_hFqYyWkHQDeHTQkiRLTKRWdXfC2uFBmaVexoGGgxMrAm6fk0TjNrItu0U4QMBC4iB2BtnQLmzdEnw6V2m7mIWzZ88obCGJfBgEwLmoMiCHJeEbqrzH9rHgRaglaVUn-5Dr-ZIMnnxgtm36O9woqoQeXY45tNM2zCSaI1WEukxv9lnkZb1ShjZuZEI3jG_aEZzniPDN8eK-VlYYaKkXAcLLCBzAO3MR6yS8q3twF6V2g83G5c6yNjYgPvJ3A5fNaHFkOXQUpjkLGM4i1W66XtTQgao9CgjThYmr-NdS1vscsvg'

Example response

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

{
  "id" : "4922e85f-aa4b-4b4e-8031-3a632ba53a51",
  "standardRoleTypeId" : "57f7d4e3-7b6b-4885-8eba-4f2c8b7a4a38",
  "createdBy" : "a3a6eff4-f584-4426-9d35-a97a8e930a26",
  "createdAt" : "2025-04-17T15:22:26.547892Z",
  "updatedAt" : "2025-04-17T15:22:26.547892Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "70440d5c-c4d8-4fca-928a-ac018b5d9721",
    "resourceTypeId" : "2652474b-988f-409f-a61f-e6eb27a70135"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 53 Admin - 70440d5c-c4d8-4fca-928a-ac018b5d9721"
}

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJZUXhYMkZFcldsX0FMMVNGT1QzNHBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjMTg1MjQxLTczYmMtNDFmNS05OTMwLTYwMzg2YTI1ZTI2YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NiwiZXhwIjoxNzQ0OTA2OTQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDQ2OTI0NzQtNjRkNi00YjEwLWFhNTItNTE1ZmU3MDVjOTU0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ2fSx7XCJpZFwiOlwiODdjMWY2MDEtNzY1YS00ZmJlLTkyZDMtZWNlNzk3Yzg0N2E0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.XBwuaP5Txv2x_u8KhKEKqavBQLpHybzj8kuTR1acXVPAupYrRIO1DByE2h-dHXY_JsxosAJXGTYdSb9owSu4NFzQFLoyi21ceMvEZpzrF51wvReA1hdpE3fZWKeAO1bjs3g4l2yt8Y9fqDrwbz2t-xC2dw1ItE2xyb5GfsO2p2gBpq97_gHLSb2dAw7wb81dYJX-vFC-PDlc7V_egrPYKco2--xXniOsseAk0Ozy-Gcm6dO2J2Z7bzmoDMCUqws6NrYoyP-bx2zGhUq9oT75PGNk2g0qa3byKH8_tcF_MYv6RZ-hW_-ylhnM7nKyISHWZNr85MyDaS7UTtGqHJ-Gtw' \
    -d '{"standardRoleTypeId":"1cd53e2d-e401-4ccd-8265-59b91127ed1a","path":[{"resourceId":"83fbcf5f-682f-4725-99a9-17cd8379358f","resourceTypeId":"13e100e1-ee86-4cc3-a578-80a53f831599"}]}'

Example response

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

{
  "id" : "5e571357-6379-452d-8801-eac9116a8b08",
  "standardRoleTypeId" : "1cd53e2d-e401-4ccd-8265-59b91127ed1a",
  "createdBy" : "6c185241-73bc-41f5-9930-60386a25e26a",
  "createdAt" : "2025-04-17T15:22:26.695165Z",
  "updatedAt" : "2025-04-17T15:22:26.695165Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "83fbcf5f-682f-4725-99a9-17cd8379358f",
    "resourceTypeId" : "13e100e1-ee86-4cc3-a578-80a53f831599"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 55 Admin - 83fbcf5f-682f-4725-99a9-17cd8379358f"
}

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/533131dd-f024-46c1-8cd1-0e9c60ff271f' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJNWE5YVVJIOTB4NXBCcEdrenlpY2tBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgxNWQwMDM3LThjMWYtNDM5ZS1iYzcyLTkzMWRmNmUzN2RiOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NiwiZXhwIjoxNzQ0OTA2OTQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTZhNTA3OTUtNTA4Yi00MjAxLWJlYzgtYmRjNzUzZWQ3OWQyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.bI6t95c-B4fOe3pBBbdyLtalHETseAMBd9_Eg-J-phNcu0PioZwxLpI0xm6Ts2hmFWrdGBWLYxmaYNomqUPbrvCspFO_fmq0b0YmyC1q5YV7hT3YrKZuSNJMwqjJCBx7D0CADJopfGNYG-bJAkeLEqIDmmu0_yvTfYiKN0mNEAmjtr24UhIlPhFy012lji8IS6Gj0ngQyxoLZtpWqU8zGMkpI87q5r-picu6yPmbIyirdwWvm5oZAr8Wrl3NQXNU3L0CfS140WHmyFDZVC1gl_u-BhMZBlTlsLWtkkV6LY96cnGxOhyAxmYYR0DoLpZMC_-fzWiIRx_GQAekqi2TIw'

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJrbEFsRVI2Tm9pZDVkV2lJWC1DXzV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU4YTg4NDRjLTdkZjctNGRhOS1iZmI4LTA5MDJhNWEyMjUxYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NywiZXhwIjoxNzQ0OTA2OTQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODRjMzRhMWYtMDk5OC00OTBmLWEzODktMWUyYTRhYTg3Zjk1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.N8BkxubOEi8BoydnivYwm-RUw4a6WkIhgpeJc0b9fFa75H8Kd8oXzko5IdpmVIINrcz72Abrhz7bpGeRp03hjoNpLVFTRtT9b81t3XkGCwGEFqqiyHdwLE1iAaX_iE_5KzvUELNuh-XIwGV4UxIC0zx8O6q3PIgMuaaZkZz-0SF_QuVXIFO5S2DX7LlShPiovnvE0ajWoQGiBwGKsSG0L3wH42Y4I17CT637tOUoC7DOuX-tSZw8-C-Vlu0cm4dOn7H7-XF7gEOqKOG4vjs-TcCyWdXxrMu1Vbg1H-Cat4eNxgHO6LHVbunVTEaTS3XxZ888T_gro50f2JTSwpymUQ'

Example response

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

[ {
  "id" : "b5ad8eba-355d-45a2-9cf0-ac0fa51d0897",
  "identityId" : "b29ca85b-c39e-421b-b1f1-aba707170c8f",
  "standardRoleId" : "da026a4b-04d7-4789-a532-a9cd31492523",
  "createdBy" : "4f6a1158-6e12-4b2c-83c4-47652163a628",
  "createdAt" : "2025-04-17T15:22:27.123732Z",
  "updatedAt" : "2025-04-17T15:22:27.123732Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 61 Admin - 26f912f9-e420-4dad-889c-23964903179e to identity b29ca85b-c39e-421b-b1f1-aba707170c8f"
}, {
  "id" : "f53367b2-e734-4742-bfd5-983d9e9c14c5",
  "identityId" : "b69d0511-7fd6-40c5-ace9-27c3f19fc7b0",
  "standardRoleId" : "de5d6c46-7535-4525-b16d-2c11d629aa77",
  "createdBy" : "97e66d27-c872-4370-9e7f-4f8582efe85c",
  "createdAt" : "2025-04-17T15:22:26.350099Z",
  "updatedAt" : "2025-04-17T15:22:26.350099Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 51 Admin - 497d306a-7f35-4150-9233-a2ea3df8b35a to identity b69d0511-7fd6-40c5-ace9-27c3f19fc7b0"
} ]

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/ca09289f-83a8-45ca-b425-47f88e2c28bd' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJia1owNk5HVEZmSUZCT1k1MERZV3RBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ3M2E0ZDQxLWIwZjEtNDdhOC1iOWQ3LWVlMTgzMGUzZjM4MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NywiZXhwIjoxNzQ0OTA2OTQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDgwYzY5MGMtMzVkNS00MmMwLWIwMDMtNjlkYmRjMWFiNTc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EoEOFLCmXBDiPOlf2D9HiK1witFCpKqBwoef1uuhrJdDecBDc6DkpUq6HufeiLGMGhXAGwT8rDLhS-oFJiEz5aIp-8nuLQC4q2fOLIFgDB3z18ENn7o8itZ2b4VZ24b0rDxykzdl0eVLJrtyeOJ7i-UU_n-jsROyGqVI_adTkkWOxUn-YwPx5PrGnp1PecO6xNs9U0tMmT186g-NXD0UAR748Xwo4h2dS2A96YKAPPQrBkP3AtEor3b0PaMDRaOxoX7wfqSseBJdYvH3gvMK0vkaW79Cd04r1Ez7ZB-33rsMf57tF-f75WxytcPFTou7PA964EO6Hf3BGBd0ghZCUw'

Example response

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

{
  "id" : "ca09289f-83a8-45ca-b425-47f88e2c28bd",
  "identityId" : "5554be30-810b-40d7-842e-9762580f2d86",
  "standardRoleId" : "ae23791c-3ea7-43f1-9d00-6ff9c753f9c4",
  "createdBy" : "6639f8b8-f6da-406e-bbdc-0f0b7ccb4068",
  "createdAt" : "2025-04-17T15:22:27.398081Z",
  "updatedAt" : "2025-04-17T15:22:27.398081Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 63 Admin - 88eed96a-c6d4-4995-8203-761bef52664b to identity 5554be30-810b-40d7-842e-9762580f2d86"
}

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJRa0RhR0tLS3JCcjRRODk5X3pJUkp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRmNmExMTU4LTZlMTItNGIyYy04M2M0LTQ3NjUyMTYzYTYyOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NywiZXhwIjoxNzQ0OTA2OTQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTI2ODEyZjMtMTFhZi00Yzc5LWEyYzktNGRlZGVlOGZlNzllXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fSx7XCJpZFwiOlwiNDc4NGVhNjEtMWNhMi00M2Q3LThlMmYtZTMwMzc2OWJkNzA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Y8QVHKVl16UW_dY_2Ng1jto1LAKSRyJT7DPnPguIwbuBVv-GN89pG6nMihkhuUvUJDqGY4GaJWllNIvdQUcLhUNiVw3rNjG-GsnLQ7u2uhjK5xpQjvmlZIw16-dPgNuR4_0qjIsPHIh1ZeXE0CIK0J_hpAQlHbUGHDDUlEKUrcJwIs2A0QN8iT5QSO02xv2ssoYnAknhs3XK1kUYRvNt9JMEOuPkcjk0-omPJlwv5bQHJOBmE8jvhFdvrvVBrodKiDMbqzTXUdROVLpX7NtrnnqRULcG_hLR6KIEaAi9oQjAPl-VFtFvhzN6b6tfaahcKW81n02_omiKdZMrC_owig' \
    -d '{"standardRoleId":"da026a4b-04d7-4789-a532-a9cd31492523","identityId":"b29ca85b-c39e-421b-b1f1-aba707170c8f"}'

Example response

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

{
  "id" : "b5ad8eba-355d-45a2-9cf0-ac0fa51d0897",
  "identityId" : "b29ca85b-c39e-421b-b1f1-aba707170c8f",
  "standardRoleId" : "da026a4b-04d7-4789-a532-a9cd31492523",
  "createdBy" : "4f6a1158-6e12-4b2c-83c4-47652163a628",
  "createdAt" : "2025-04-17T15:22:27.123732Z",
  "updatedAt" : "2025-04-17T15:22:27.123732Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 61 Admin - 26f912f9-e420-4dad-889c-23964903179e to identity b29ca85b-c39e-421b-b1f1-aba707170c8f"
}

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/b2ef3d01-b67c-49d7-9ff8-bb02ad66fe3a' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJYNEhfZFVvRkxLQUlQcjVLZXVfS1JBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY0NTU3ZjUyLTE5MDUtNDZhZS1iNDVlLTRiYjcxODQyM2JjZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NywiZXhwIjoxNzQ0OTA2OTQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWQ3ZGQzMjQtYTI5MS00NGE3LThjMmEtNWVlZGYzZmQ2NjI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.JRBNhLi8pGw2fiz2k26cPzCQ4gZcIZt2RSoTmuks1cjkpWR8nBiWYwNnthzNVldXAx25zIjDtCmD7AW1_VrHxOyZYj6DkUw3iQEySyk7Sl4l-IDzNf84bWQowP7W39h3da4C5kY_NQ6a_361tmZ_BdAnr60C0q7E4BojNPXMcIbe57YRY3oLtfUTlnPHWwZvYnbovtZ3ZE6BDC9-K7PkFFcxFyeqMpK_IaiJ7xAEKnrbtIRBLS7Nb2dt8jZOniCNBU3QhhHfFcaiB_CzxINkpDz-6yUhbz_HEFzs31i6uKy8iMhC4NYnhvfugu5-SFvoGB1clLdyS1plTi84sAFryg'

Example response

HTTP/1.1 200 OK

Standard Role Types

Find Standard Role Types

GET /standard-role-types

Authorization

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

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

resourceTypeId

Object

true

resourceTypeIds

Object

true

Deprecated..

authorizationStrategyName

Object

true

authorizationStrategyNames

Object

true

Deprecated..

includedByStandardRoleTypeId

Object

true

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].resourceTypeId

String

true

Must not be null.

[].authorizationStrategyName

String

true

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

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJNdVZ6SzY4OEdaSGdTdUYyQTNOYmZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY1MDUzZWUxLTI4YjItNDY3ZC05ZDY3LWQ0YjU2Y2QyYmZmOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NywiZXhwIjoxNzQ0OTA2OTQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmQ1MjFiZGQtY2JhOC00YTlkLWIwYjAtYWJhZTU0YjUzYWUxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Mua5fjql9XkG_E2j9S6PQSuZog4tOsmZFKcaMM36Je-aUbkPAPsgfN0_eeSeksNYtcrtqrLIDmd4mSexXJ_i9462p1wMGOQI1BpTAqd_WBtwKY_nEBW9aYEuacC2R8mpLdZUUzS9JMLSdb5RqCvfjk_5-JgcxfW2khCW4Cc1rhbj7-k9x8tYhkJPEfJcgLayGs2mrk00a_V_76cqppu53j5yqNSE2TRReOqMgADplnBpgrG4y5VCCK7UZkgZ2ziXFXsiET4VaFPwd46fl0VkZ8ZHLKQNW5_xyiATJumkgimYQEUOkpM9sXk3dLdpQ4K5r3xsn5xP7x1UEnkWT-wU5w'

Example response

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

[ {
  "id" : "ff36a63d-3c8f-4d4e-bb2c-7e7b7d2289c2",
  "resourceTypeId" : "676019dd-4ccb-4ba3-9350-9ab713010863",
  "authorizationStrategyName" : "Admin",
  "createdBy" : "b90ff333-7c80-4bb8-a4c0-e3f178e8abca",
  "createdAt" : "2025-04-17T15:22:26.286753Z",
  "updatedAt" : "2025-04-17T15:22:26.286753Z",
  "_title" : "Test Type 51 Admin"
}, {
  "id" : "ae9f0d9a-9adb-453d-a443-efc41fb4f511",
  "resourceTypeId" : "0def6585-aa33-4cf3-bdc9-f3d95c9a7227",
  "authorizationStrategyName" : "Admin",
  "createdBy" : "6c804cfd-8b22-43fa-ba6b-e831b4022fa4",
  "createdAt" : "2025-04-17T15:22:26.863599Z",
  "updatedAt" : "2025-04-17T15:22:26.863599Z",
  "_title" : "Test Type 57 Admin"
}, {
  "id" : "ffca70e0-c426-4fec-9e36-208d67b769a5",
  "resourceTypeId" : "91823b5a-b8f9-4b04-a87d-3595d27e7c00",
  "authorizationStrategyName" : "Read-Only",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:47.818782Z",
  "updatedAt" : "2025-04-17T15:21:47.818782Z",
  "_title" : "Network Group Read-Only"
} ]

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.

createdBy

String

true

Must not be null.

createdAt

String

true

Must not be null.

updatedAt

String

true

Must not be null.

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types/fc48f71f-1c5e-49e8-85ac-510b451b5711' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJUdzNXNExDMmk3ckdDbTR2Ui11clRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQyZjA0ZGQ0LTFiNTEtNGU5OS1hOTllLTNjM2QwY2I0MDlhYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NywiZXhwIjoxNzQ0OTA2OTQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGYwMDc0ZjEtYWEyMi00ODFjLWI5YjUtOTExOGUzMjc0M2FiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.CvajczmIip6LSoevYaH_CHkv-ZxEWsXGPSHoT8v2WappQc2YafP8pf57QtaedlkDypQDhHPoQOg_SjGTRUy47r9aTJIt-PqOBdtRc0q6hVI3tir9fx52rIOFz5nzDRpI6LgHVLkGsbnkPn85045ICwhCb9ixr7x8f40SDQDCY855mTXyUDPd-h3Qns4eFmodK0LCiN39NNEGs1bU41ahrqrf6lf6R1y1Bvrbe2r0UDmHkKJPQEkUrdMWB1J8tlDofsPyxL_7YJh3_2yh4zrbufGfwSH4V-MhNxh__1sSnUrUj5WGD95CMFsQaq2pVW3Gf-8imHGDjf_P-98r561PCA'

Example response

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

{
  "id" : "fc48f71f-1c5e-49e8-85ac-510b451b5711",
  "resourceTypeId" : "8d9d8ad8-95cb-48d7-b079-fce1c70895a0",
  "authorizationStrategyName" : "Admin",
  "createdBy" : "a59f7507-82f3-4ae0-8d64-4a01b1a0b8be",
  "createdAt" : "2025-04-17T15:22:27.696522Z",
  "updatedAt" : "2025-04-17T15:22:27.696522Z",
  "_title" : "Test Type 67 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.

createdBy

String

true

Must not be null.

createdAt

String

true

Must not be null.

updatedAt

String

true

Must not be null.

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJuNmF6VldQb3d0MTZ4SHozVDRpVF93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYzMzI0NTc1LTM2M2MtNDczOC1hOWYzLTBiNjRlNzQ0ZjQyMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzM0NywiZXhwIjoxNzQ0OTA2OTQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjc3YjBkMjhiLWYwZmItNDRlZC1iYzI2LTEyZWZiZDRmMThhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NX0se1wiaWRcIjpcIjgxNDVjN2FmLTdkNmEtNDZkMS1hZjYyLTI2NzU3NjZjYzM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzM0NH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjJjZDcwY2QtMGUxOC00ZGY3LWIzMGUtZWRmODM4NmM1MmIyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fSx7XCJpZFwiOlwiYjQwODYzZmEtOWM5MS00ZTgyLTg3MmYtYjc0NjQzMGYyY2QzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzQ3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.eMNdux67u9sesZGcabwv7pwxHaG_gzL5cZiSaboeHosIiGQuDfJ_dUiqGVfYaNM-PhI1zNbSRnAVrmhGGd5U_xtqRAPlumgdx3D5Aj2gQsXHEVPH35MwYyajPCdLukyGaNfg0lGlPwxaUjcf8Be2Vg0uDfnq_Ob1Uh3Hr1o2Sj76Blw37ga8uJEUxEvgnYZlbqrLcuDtn-mtUdMNQsWLPTVQHPfof4kQT0dN3EY8J72d9GyR3V7OT7iiRRmz4EtXSHGk8YP5qgONa4j-l65ehHHh_HnQfJizxbTU4L1vS1zKGVHPISdpd0HcsfHBoF6lMK0_azfWiMBRvaxbZXyqFg' \
    -d '{"resourceTypeId":"baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59","authorizationStrategy":"Admin"}'

Example response

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

{
  "id" : "e61c33e2-f453-4fc4-b487-aa131e584184",
  "resourceTypeId" : "baa8f10d-9a27-4bb4-b6e4-3c7e5ab9fb59",
  "authorizationStrategyName" : "Admin",
  "createdBy" : "63324575-363c-4738-a9f3-0b64e744f423",
  "createdAt" : "2025-04-17T15:22:27.630493Z",
  "updatedAt" : "2025-04-17T15:22:27.630493Z",
  "_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.

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJ3aTVOM2ctWFFlcElUb0tOM1NEVHhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBlNTViMDM0LTk5MzgtNGI1MC1hYmMzLTI2N2U5YzhlZTBjMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzMzOCwiZXhwIjoxNzQ0OTA2OTM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOWRhYzlkZTctZGMwMi00MjVjLWJjODAtYmRhNGQxOTNjYWQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzM4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.J0JlXn18BYABNaXDFcnuExnoiwmwR7RCMqP1G907PXkUhSCLwt6H0LIbvElBNDj8ep8d7ywFK5tev4J1BNR_oV6SC9wMtdAz8vbmmKj5fUUOOmc9Y_Byv6pbYLtXYXwxsesQDkO74GBsm6BlJZJAC1o_3SJFzCRfG2TPSQBAr0C89T5mlogYjl4VxRF0R9nPcD88jraUGT6PS3HyHNXOEy01iz04N1XCuC7PB8VYRN31K8EehjtM3i6p-S8OQDqLrVZwLUeqHX_TeGnz0Y6rYA34kW019fIKJ-ZogWOAHoia1BdoIBCIk_rIW9oITZ9rlTS_oKMt5pAT7yXtmKMrGA'

Example response

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

[ {
  "id" : "cb013f73-7b2e-4044-a992-df97d5102072",
  "resourceActionId" : "809ac980-b7a9-41a8-8beb-cb112dec075d",
  "authorizationStrategyName" : "Admin",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:49.751195Z",
  "updatedAt" : "2025-04-17T15:21:49.751195Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Update Identity Session in Admin Standard Roles"
}, {
  "id" : "e4f54ec7-bf4e-4357-9c70-d192814c5a83",
  "resourceActionId" : "5dd73cfa-620f-4576-a8a3-bffe26818102",
  "authorizationStrategyName" : "Read-Only",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:50.033144Z",
  "updatedAt" : "2025-04-17T15:21:50.033144Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Read Network Controller in Read-Only Standard Roles"
}, {
  "id" : "7dfe8316-2cc5-4058-9877-41e17796472a",
  "resourceActionId" : "83e783dc-66d0-4061-a397-da002e644e4e",
  "authorizationStrategyName" : "Contributor",
  "includeWhenAbove" : true,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2025-04-17T15:21:48.767804Z",
  "updatedAt" : "2025-04-17T15:21:48.767804Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Read Azure Virtual WAN Site in Contributor Standard Roles"
} ]

Get Action Inclusion

GET /action-inclusions/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

resourceActionId

String

true

Must not be null.

authorizationStrategyName

String

true

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

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/a4a1a994-2caf-4b5d-992b-c2532edc0687' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiIxVnlzcDRlUHJqaDRXWUFma3owUFFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQwZTQ2MzJiLTcwNTgtNGNiOS05MjE1LThjODIzOGM5ZjRlZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzMzOSwiZXhwIjoxNzQ0OTA2OTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWM5ZGNlMGQtN2FhNy00MWU1LWIzNjAtMzliYjFiOTdiY2Y4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.a8PyTdcwhj8Z2DUBNuu3bVJlDCydB6PbkXWF0L78Wct22NnoxO9mnDSWD0DkaDY0aKJUYthLcx6J6R7Rt1Ll0sct7j5apKFhzI3PrNUdlyHy5iYI-gtJ1rExZTdWT5TxzA1jsZo7vMaLO5izcvj2MZ2kFBKHaQyAvVaDMaPzEzThMcTcO92rrWPN84q7NI0deKF8jX-Y_Gf8fDwgQTGZFuA9u5gQQJfozs-FwWl4gT00r_9XxuMBUq3hMHX_D796UTFQKY9cQ84qy7l7Vl5-ozy5zjjbLMJaKavx7CB87TD0j0q1s2TJMz_Pyt9Z-gfBMgtxvALZUt5fnqWVsvYtMA'

Example response

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

{
  "id" : "a4a1a994-2caf-4b5d-992b-c2532edc0687",
  "resourceActionId" : "ac30c6fd-80c7-411e-af50-9452132cf169",
  "authorizationStrategyName" : "Admin",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "c17d7a31-978a-4402-8020-ff0a8597f846",
  "createdAt" : "2025-04-17T15:22:19.348255Z",
  "updatedAt" : "2025-04-17T15:22:19.348255Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Test Action 15 Test Type 14 in Admin Standard Roles"
}

Create Action Inclusion

POST /action-inclusions

Authorization

This endpoint requires the following actions:

  • create action on 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.

[].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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiI2ekd3d08waFlmMXRzc04wX3hPV1lBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU1NzMzYWZmLTZiYjEtNDYyMy1hZWY5LThjYjZlNmRlMDNhMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzMzOSwiZXhwIjoxNzQ0OTA2OTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjA5N2UyYzItZDkxZi00NjNiLTgwMzAtMmIyYThmNzFiMTg4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzM5fSx7XCJpZFwiOlwiYTVhNjhmYzMtNGVkMC00MjhmLTg2ODktZWEwODdjNDdkYThiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.J9WxLmHAImOQ1Tw9p9F9LxvLJw855DpiUVihy5syRiLfk0oUS62pSse9fUPC5oMI0cC86M6SWAGsuvxSKLXd1WhutqaQl8FHWtxqxsbVM3S7LB8EdAsRISLVNwcTiGwVuLkIiPfzhBYB3FzUFfhOrJuIpv3dBWljV9Oz_VGUDT1jiFs4LGZHLc1TlEBjRhGYMBm8LMi-rDVWpKFbFzuHC1RVjFppMIVazfk-6_6WXk_AAh6jWZhHyiPg8Ph0u9Upr2rBmWGLi7GYl_FidirmJQX3K8Lz-zK8_93sDNFW1HiZlBwAC-nNB9rCMxmwkRlyBchpEXD5nTr9VJVDcOVviw' \
    -d '{"resourceActionId":"efe38449-e0f8-4422-89fa-229ae7a34c73","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'

Example response

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

[ {
  "id" : "0c93b093-17f4-4c30-b62d-4a9f0f8cd7fb",
  "resourceActionId" : "efe38449-e0f8-4422-89fa-229ae7a34c73",
  "authorizationStrategyName" : "Admin",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "e5733aff-6bb1-4623-aef9-8cb6e6de03a0",
  "createdAt" : "2025-04-17T15:22:20.012871Z",
  "updatedAt" : "2025-04-17T15:22:20.012871Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Test Action 21 Test Type 20 in Admin Standard Roles"
} ]

Delete Action Inclusion

DELETE /action-inclusions/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions/9f491550-ea35-43f6-9da9-4edf517c5d5c' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjRjYzg3MjU2LWI0NWQtNDRlNC1iNjNmLTVmYTZiOTZjZTliZSJ9.eyJqdGkiOiJfQTd2aXRyTG1mM0UxdDE0T2FGZDFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVlMDg0NGViLTNiNjgtNDk5Mi1iNDdmLTAyYTI1ZjRmZDcyYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc0NDkwMzMzOSwiZXhwIjoxNzQ0OTA2OTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjliNzgxODlmLTVlYTItNDRmNS1iMWY1LTNmNjA4N2NjNWQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMX0se1wiaWRcIjpcIjdkZjZhNzFjLWJkOGUtNGZiMS05ZDY0LTE2Mzc1Y2FhMTJlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjM0NWQ5ODI4LWNjY2QtNDRiZi04NzJlLWU3ZjgwMjI1ZGYzZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImI4OWY3M2FiLWUyYTktNGU2ZS1iOWFmLWZjNGEwZjhmMmE1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOX0se1wiaWRcIjpcIjVjMGYzZGRlLWJkZDQtNDUxYi1hMmNjLTUwZmIyMWVlZDQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjgyMjFjOTE3LWY5ODQtNDlkMy04MTYwLTZjZWM4OGY5MzIwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImJmZGNlODlkLTcxODUtNDdkOC04MTA5LTU2MjlhNmU4ZDg1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMxMH0se1wiaWRcIjpcImZlZTVhZjNiLWM5MGUtNDYzZi1iZDMxLTFjMThiYjJhMWJlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcImMwODU4MWEwLTQ0ZmUtNDdhOC04YzA0LTdjYTY0MmQwZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMwOH0se1wiaWRcIjpcIjA4ZDhhZGVhLThlMzAtNDU2Mi04N2FhLTVjNTllNWJhN2E3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTc0NDkwMzMyM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTI0YjAxZWQtYjAyMy00YTAyLTg1ODItOWI4NDkzZTYxOGNmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzQ0OTAzMzM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.S0o_ZwtzFTlvDU09qZ578tBLOSVb_6_K-jH9y7WnLmK_AP8TAs1gmUWFGB291FF7HVtrJFy1jICy5iYJsJgo1oz2O41PWAl3h5xUXomaKHFa-oBFvwcDExtfMOWzM5YeHkCG8qDWFDNTfCI_hgZnOsmfM8IaZwe1P0KnnhfCXd3yNWgmyN-jRBYj6a_q-RH41LDnqucLoWwEMQzAUxpYYuGELhWzI83CmbNgDxQXMUAdSO6-Svzddkql1HVxIqfRLhWhxAnZzT1EYZD3eWGZqc23jomoc3F7LpmpvHlq3ZGuG1HSJEHh97mxUzjut0rWF9d3CjkRtJh7g7SpiJXflg'

Example response

HTTP/1.1 200 OK