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

Exchange a NetFoundry token with a service identity for a NetFoundry token with a user identity.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiI3YnV5NEY2cE1xaGlTQk9taXBPNGJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM0NzdkNGVmLWFmZmYtNDMxZS1hYWQ5LTY1ZDg0ZWRjNTc2ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjg5OWNlNjVjLWQ3NDQtNGJlMy1hYTA1LTczYWRjYzc3MWFjZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgyMH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMTFhMTM0MDYtZWQyNS00NjVkLTlkOGYtZmRmM2U5ZmZjMjhkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiYjAzMjU4NzItNTUzZi00NDM3LTgzODAtZDRkZTY2ZDdhOTgyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA2fSx7XCJpZFwiOlwiNTQ5YmI4NzgtYThkMy00NGMwLWJhNGMtMTFjMDgyNWQ1NmI1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fSx7XCJpZFwiOlwiZjY1ODFjYzMtNjIyNS00YWEwLWE5ZDgtMDBhM2ViYTE1M2Y4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA0fSx7XCJpZFwiOlwiNGQzNWQ2M2QtMTcxYS00MmU1LWIzYzctNGUwY2EyMGE1Mjc5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODExfSx7XCJpZFwiOlwiOTY2ZjJkNDUtYjdjMi00NDlmLTlhYzYtNjgxN2Q2NzhiMTljXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiYjAyMzkxYjEtYjIxZC00OTUxLTk1ODMtMmY3ZDc3MjczMmIxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA0fSx7XCJpZFwiOlwiY2NkZDEwODAtMmIzOC00YjIxLThhMjItMmVhZDk3M2VhNDA0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fSx7XCJpZFwiOlwiOGRhNTI5NmEtMGE4Mi00NDU0LWJiZmQtYmE4NTk1YjZkY2FkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiMDg0ZmRhZTAtZDJkOS00NmQ5LTgxM2UtNzFjOGE1OWQxNDRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiY2FmM2Y2YTctZTI5Zi00ZDA3LTgwYzktMmY1OWU2OWQ5YjQ2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiODk1NmNiMjYtYmZkYi00ZGViLThjZmEtYWJiNmE3ODJlYjRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.M6oJMYwE_AvW3_5v4NVbZjEl5qp4xDgkAiWLmIyKuYK9Vfj_xP3PahirY6-lhldjiPY4YJjOZdeeErLmDAIdXiBmrDGiuIO-VQRGzmTG78ldkpheZHCyDxfO5fvgqQhbnkmw07Uuv5zcnt9BDJXIETLjT2oglqFpqC_HDW6QMrGoDzn0_tRkxmFjG3yGjL1pGSNFC-w7qL5YE9VUtVRrQ8fqLdaFNFYKbZxmp3C_WA_ZIar6HfxjsUiRifPAVzTIwAX3Sj2IPnzyF1LbLIoS6RThbf_PCZSInxVYJgNQYxn-h6346sjvABinjyVbYB6cxjHk7hTJzXXQF8Zl0Pcx4g' \
    -d '{"identityId":"191810ec-83f1-47d4-9580-3cc8bc2f6f0d","audience":"io.netfoundry.test","claims":{}}'

Example response

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

{
  "token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJORTdiQTNNMXI4TVFpenoxaUIyd1JBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE5MTgxMGVjLTgzZjEtNDdkNC05NTgwLTNjYzhiYzJmNmYwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY1MTIwLCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjVhNzkxNWRhLWU0NDMtNDEwZS1hMWZlLTEyMzdhMjA5ODgzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjM1NDhmNWY5LWQ4NzAtNGE5Ni1hYzdmLWRmMTYzZTA0ZWY5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgyMH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMTFhMTM0MDYtZWQyNS00NjVkLTlkOGYtZmRmM2U5ZmZjMjhkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiYjAzMjU4NzItNTUzZi00NDM3LTgzODAtZDRkZTY2ZDdhOTgyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA2fSx7XCJpZFwiOlwiNTQ5YmI4NzgtYThkMy00NGMwLWJhNGMtMTFjMDgyNWQ1NmI1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fSx7XCJpZFwiOlwiZjY1ODFjYzMtNjIyNS00YWEwLWE5ZDgtMDBhM2ViYTE1M2Y4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA0fSx7XCJpZFwiOlwiNGQzNWQ2M2QtMTcxYS00MmU1LWIzYzctNGUwY2EyMGE1Mjc5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODExfSx7XCJpZFwiOlwiOTY2ZjJkNDUtYjdjMi00NDlmLTlhYzYtNjgxN2Q2NzhiMTljXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiYjAyMzkxYjEtYjIxZC00OTUxLTk1ODMtMmY3ZDc3MjczMmIxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA0fSx7XCJpZFwiOlwiY2NkZDEwODAtMmIzOC00YjIxLThhMjItMmVhZDk3M2VhNDA0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fSx7XCJpZFwiOlwiOGRhNTI5NmEtMGE4Mi00NDU0LWJiZmQtYmE4NTk1YjZkY2FkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiMDg0ZmRhZTAtZDJkOS00NmQ5LTgxM2UtNzFjOGE1OWQxNDRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiY2FmM2Y2YTctZTI5Zi00ZDA3LTgwYzktMmY1OWU2OWQ5YjQ2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiODk1NmNiMjYtYmZkYi00ZGViLThjZmEtYWJiNmE3ODJlYjRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.I2hc1FhXvoPBMaEcBL5GThnmjyVQQ2wqR-Slr9-UJqwVHM_23his5TvNczsCPiG0VZ-KDpjeW2RNV9DkugTRlRSsaBHDMeIRzNrR-0Lk6clCSiRnzPUQXJbIuxTPfarGAhOU0GnN9kLvW0W8WLqjVwwFXpt58kwgFYSkkdF1ISp6_muE5diIlKy25M6K77LbpGvY0npQ-_yuoEaPUGOLN_yHLSdA36TX2i_0v0iK3tkg7gKes0d-FLqmbb0iiuou3yn5hTHifOTnGtwKAxvxseEKVdoulK_uh7jxndDB_8KFjhH_2S1ZrFbihEsuKMbKNeVkzzoEwVivyRAMnX6ahg"
}

Core Authorization Resources

Domains

Find Domains

GET /domains

Returns a set of {@link Domain}s that the client is authorized to read.

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

A human friendly name which can be used for UX purposes.

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

[].code

String

true

A globally unique value that can be used by code to namespace other values which only have to be unique within a domain, such as a resource’s key. This value must be formatted as an inverse domain name. For example, "io.netfoundry.authorization" for the colloquial 'authorization' domain.

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

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link Domain} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link Domain} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/domains' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJ4STlaalZQQ3phd0pnYVB3aW9MZjF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE5MjE0MjUwLTE2NzktNDAyNC1hNzUxLTk1ZDE1MGZlYmJjMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNiwiZXhwIjoxNzAxMjY4NDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGJiYTdlMmMtNGJlNy00OWJkLTkyMmQtYWE2ZTYxMzQyYmYzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.irDnYBOHFXB4p_cS8G0zHlAbpFlcFJ8g5Fc1eXjKSsk8-Ff2shagksqaCFoV7ZjaeX8HMswyc-knX2aJVV6Avj8o9xXhlequzBk0F4DJipCKsJJlC9AnYeCtt4teo88PeQ2B_Rw1TtARkEIz7geQBwP00jtj6o358njJX4q1xrNg8wizd4F7bSS4btkVwi7EQCS--gzIZZ_UGyKto0umqxe6MmjbUWYsOhu3TNwz4NdzLiE1jE-iZlbkJSaMb-YnlBRcS9PnepC0ptg4jO3InT_I5TuyMNIgUhH6CoC2xZG8WGM-EL0cKmuDztaAZW5SS2dI-TTKsHpFmk_A7BuBvg'

Example response

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

[ {
  "id" : "cb391709-4e92-498f-9430-3a45087690e0",
  "name" : "Test Domain 3",
  "code" : "test.domain.3",
  "createdBy" : "4a2d48ff-ab01-413b-b7b8-da26ec7339d1",
  "createdAt" : "2023-11-29T13:33:34.921556Z",
  "updatedAt" : "2023-11-29T13:33:34.921556Z",
  "_title" : "Test Domain 3"
}, {
  "id" : "db151213-5e29-4be1-9dbb-08e766240474",
  "name" : "Organizations and Identities",
  "code" : "io.netfoundry.identity",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:22.489356Z",
  "updatedAt" : "2023-11-29T13:33:22.489356Z",
  "_title" : "Organizations and Identities"
}, {
  "id" : "4b3c6c78-9ea4-439b-8184-2319c1cbbb4b",
  "name" : "Test Domain 9",
  "code" : "test.domain.9",
  "createdBy" : "5b2240d2-ce62-4c4e-aae7-ee348ebe0a32",
  "createdAt" : "2023-11-29T13:33:35.966858Z",
  "updatedAt" : "2023-11-29T13:33:35.966858Z",
  "_title" : "Test Domain 9"
} ]

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

A human friendly name which can be used for UX purposes.

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

code

String

true

A globally unique value that can be used by code to namespace other values which only have to be unique within a domain, such as a resource’s key. This value must be formatted as an inverse domain name. For example, "io.netfoundry.authorization" for the colloquial 'authorization' domain.

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link Domain} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link Domain} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/domains/2a5ea952-b314-4e2c-89fd-632cc6c76fc9' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiItQjhOZ2I2OWNVTTFCR19aeUptTHlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM1MWQ2NjI1LTk2MjQtNGI3YS04OTZlLTc2YmNmYTNlMmZiMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNiwiZXhwIjoxNzAxMjY4NDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjcxNjM4MTYtZDA2Ni00OTc3LTk3ZjQtYTYxNGE1MDU2NTJkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.dJJ3cDBEgfuY-mdWiNln8HYd-I7pKbBG8dT2VNl3pWIB51BAgS_xXqr-Uz3Chu-4NfR9jLEVrF5G5wuUa9cHaYVc2xlRHRw-PVhkoMo646iqxyVGfyRCXzprA0VJov-GF5LYiV3wW2lO31rsQi1cXj4xyOC25U91osW6wDB4J4VOZwN-ZBRGtZgD4GgX_zziariDJbcoDKcDPAJJbYn2fhhgRorzcQFcK-Puv6pHSrPxxUJQuApNCw_BImkhG-93yuvR3DHTIvJo1WobMjT-8Q8D4zcfUg-tqS-RN6_qzkZxr2qG0riVkiLopkIucd5xwpvT1V3eA7rqFnEbDMAnuQ'

Example response

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

{
  "id" : "2a5ea952-b314-4e2c-89fd-632cc6c76fc9",
  "name" : "Test Domain",
  "code" : "io.netfoundry.test",
  "createdBy" : "c7b25512-359a-41aa-b5b4-c7f56c8e1328",
  "createdAt" : "2023-11-29T13:33:31.631136Z",
  "updatedAt" : "2023-11-29T13:33:31.631136Z",
  "_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

A human friendly name which can be used for UX purposes.

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

code

String

true

A globally unique value that can be used by code to namespace other values which only have to be unique within a domain, such as a resource’s key. This value must be formatted as an inverse domain name. For example, "io.netfoundry.authorization" for the colloquial 'authorization' domain.

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link Domain} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link Domain} was updated. The only supported 'update' on this bean is to mark it as deleted.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJaQzdrUlg4OEtBU2xhb3pfbFB2NDh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFlMzJhMjE2LWMwMzQtNDU3YS1hYWJiLTE3YzYwNTdjMTE1ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNiwiZXhwIjoxNzAxMjY4NDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGViZmEzNGEtYTU3NC00YjQxLThkMTAtMGM3OTcyMGFjMjlkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.sIKuL1zyAM-vMQY2ACyyShoGKkG9JZ3j8vFhy7pPjeO7dpZCLg60lpswcOur8_FHFHzQ5bZwL1118tbCr5w_-EYHC4qjOV8f4DvtXEV5jNGyBc-cDFxJkP_8lmpW4-QrIHM26yHb3aEA4YankTuptHrY4WTlWxXxaTtk8boKWVLyNy82mAOVIvSeBqcQecpk-rJVt41a9ZOX6sH57PpnYrMjR7IjAJf6M2Ehwfffh0SXChrI0QivSjnf9d16_vp9IM9XcB49T79XUw0QRnLu1e_TET1WrDX3l6MNzD0AB6hPowWdDNpbQX2yYR6ZKSwx4YzKvLjXIV8cvsY0YZtU5g'

Example response

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

{
  "id" : "2a5ea952-b314-4e2c-89fd-632cc6c76fc9",
  "name" : "Test Domain",
  "code" : "io.netfoundry.test",
  "createdBy" : "c7b25512-359a-41aa-b5b4-c7f56c8e1328",
  "createdAt" : "2023-11-29T13:33:31.631136Z",
  "updatedAt" : "2023-11-29T13:33:31.631136Z",
  "_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

A human friendly name which can be used for UX purposes.

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

code

String

true

A globally unique value that can be used by code to namespace other values which only have to be unique within a domain, such as a resource’s key. This value must be formatted as an inverse domain name. For example, "io.netfoundry.authorization" for the colloquial 'authorization' domain.

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link Domain} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link Domain} was updated. The only supported 'update' on this bean is to mark it as deleted.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJHRWF2Q1hNQTdYUzFHRFRsakI4QS1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ3ZWY3NjI3LTRiZWMtNGNiZS1iZDYwLTVkZDVmM2E3OWFkMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNiwiZXhwIjoxNzAxMjY4NDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGY5ZjkyZjYtYzBmZC00MTQ0LThjYWItNjE4ZjUzZjNlOGIwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.bvZyap6jSZQC6-_E2dHhglkVjNfezD3_vhD6T8H2E6BqcjvoXgw58x-KepvHy40eWYAy_OgbXyl582CSLTsQqjNbdmL2W6VpnBdYbelgavwmOmtTRMKAnidRhovfYO2FIkp-j-hfWaPu7iu0qAHPNfuaRA_q_fMtkrpdZqtwaT1A_gUnvpZG3JPdQbX9F3f_mtf8NK5rhdkjiEoqVtGvLc4yOCo4nHIWAcsIgZiUXrWzVUWQnFmIumUZJUc-4Fk8LslXQIdwtBC3g7F91OB4N_ahu0Qamxzt2TZyu1a9ElN1x9C7sU3XtfpodDv-j4H_MxpesZP6rybkT6cKkHrkuQ' \
    -d '{"name":"Other Test Domain","code":"other.test.domain"}'

Example response

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

{
  "id" : "105f45bf-96f0-49c2-8070-150366f13524",
  "name" : "Other Test Domain",
  "code" : "other.test.domain",
  "createdBy" : "47ef7627-4bec-4cbe-bd60-5dd5f3a79ad0",
  "createdAt" : "2023-11-29T13:33:36.704029Z",
  "updatedAt" : "2023-11-29T13:33:36.704029Z",
  "_title" : "Other Test Domain"
}

Resource Types

Find Resource Types

GET /resource-types

Returns a set of {@link ResourceType}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

{@link ResourceType}s.

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

Filters results to those that are in one of the specified ,{@link Domain},s.

code

Object

true

Filters results to those matching one of the specified codes.

parentId

Object

true

Filters results to those that are an immediate child of one of the specified ,{@link ResourceType},s.

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].domainId

String

true

The id of the domain within which this {@link ResourceType} exists.

Must not be null.

[].name

String

true

The human friendly name of this {@link ResourceType}.

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

[].code

String

true

A unique value (within the domain) that can be used by code as a reference to this resource type. These values should almost always be the simple type name of the resource class, such as "BillingAccount".

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

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link ResourceType} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link ResourceType} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].root

Boolean

true

[].parentId

String

true

Returns the id of the parent {@link ResourceType} or null if this is a root.

[].depth

Integer

true

Returns the depth of this {@link ResourceType} within the tree, where a root {@link ResourceType} has a depth of 0.

[].childrenIds

Array[Object]

true

Returns the id of {@link ResourceType}s that are children of this.

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/resource-types' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJ3SGV1WnAwZ0hJTjVXZGhTOUVRdUZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZkNzA4ODY4LTY2OWMtNDcyZC1hNTU0LTk2ZGJmYTY3MDdkOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZmEzMTBlNGEtNWIxYi00NzMzLWFkNWYtYmViMDE2Nzc3YTg0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.oq_8Jro1QKmkERa70rik2aqjWWEYG9ewm5SVAtBK18Zv6TyYhWS0D0lOrH6rHmbLth56sDuZAo5Lg9je2w6zb9RQSAhf1EIPZmXZx1wIDJoLzymVZzF64EvHfV7wxSRNrc805MZPBKtUM9Dkm023S7zlUV_mggLhuq7evi8dv8SZi7DVVqlcuOlRBKa16j5Z08aRHIVN0MWZyrL2qpouMbPeJ21AQithRIkBtyMXYGaE7hLpWcQebXdiyyL7NpiH3YwXkcNzmmjYxwZxRKmtTM6SNjtrG4E04uqeNhUBxUycHgKphMiBfFaqi-qdOj3m3Hn4SR7rwNpvE37oMPpP7Q'

Example response

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

[ {
  "id" : "b2b8916f-8d1a-4dc1-af72-9ce3eb462e97",
  "domainId" : "a5e9c7b1-3a74-49b6-aabf-c61a2b628a46",
  "name" : "Banner Template",
  "code" : "banner-template",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:27.256811Z",
  "updatedAt" : "2023-11-29T13:33:27.256811Z",
  "root" : true,
  "parentId" : null,
  "depth" : 0,
  "childrenIds" : [ ],
  "_title" : "Banner Template"
}, {
  "id" : "b0bc3699-7b54-4239-842c-f0d67702d107",
  "domainId" : "48b480aa-f647-464e-a714-65f5c49664b9",
  "name" : "Test Type 16",
  "code" : "Test-Type-16",
  "createdBy" : "eeeffed6-2cb5-4b78-9330-088aed95a986",
  "createdAt" : "2023-11-29T13:33:36.767222Z",
  "updatedAt" : "2023-11-29T13:33:36.767222Z",
  "root" : true,
  "parentId" : null,
  "depth" : 0,
  "childrenIds" : [ ],
  "_title" : "Test Type 16"
}, {
  "id" : "021a2593-fefa-4723-98d7-82f1140b1d9b",
  "domainId" : "3c4fa924-5703-46ff-a701-71b466810b39",
  "name" : "Service Group",
  "code" : "service-group",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.054399Z",
  "updatedAt" : "2023-11-29T13:33:23.054399Z",
  "root" : false,
  "parentId" : "b9b84566-a819-4e1c-9ed8-49310e5b06ef",
  "depth" : 2,
  "childrenIds" : [ ],
  "_title" : "Service Group"
} ]

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

The id of the domain within which this {@link ResourceType} exists.

Must not be null.

name

String

true

The human friendly name of this {@link ResourceType}.

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

code

String

true

A unique value (within the domain) that can be used by code as a reference to this resource type. These values should almost always be the simple type name of the resource class, such as "BillingAccount".

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link ResourceType} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link ResourceType} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

root

Boolean

true

parentId

String

true

Returns the id of the parent {@link ResourceType} or null if this is a root.

depth

Integer

true

Returns the depth of this {@link ResourceType} within the tree, where a root {@link ResourceType} has a depth of 0.

childrenIds

Array[Object]

true

Returns the id of {@link ResourceType}s that are children of this.

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/resource-types/36d9ef9c-c535-4978-aa98-5730cc5e1460' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJKQVMteF9Ld29SQk5lV19faDkxdERnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNjYWNiYmJjLTVhNzgtNGZhZi1iZDM2LWI5ZTBlZTZmZDQyNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZmFhMTc5YzAtMDI3MS00ODU2LTg5YzEtNzI4ZTVmYTIyMTQ3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.k8_MnmL3q1JY8_jNP8cLUF6MOg40VlkUdzB45tTIUiDwjJC4ZldRuooC9mArolwCadXEyt7w-l8xP8JQdumZ51bWC8ZUEaYBotP3aGkHS4Zdzu5DEmvqRs2kYRxP3eyy8f_BovoguCejsXhwT9XbPb10rg__mdeR0V8GwWT5Hot_7wMvdYVwKc_YTUze7ihJj7bwjh77_m2ZEHhns3-z8H2xd2qUNguqmygUjJ5Bo5AX6uSv6aalJB1Hg7W-CKC_1ASL3y9OFMxSWOKLd6dpCqFtyECEmK1jVeXOMNbAp__kvrUI6zSoOtptbrftXFBfT7kjJM5jYFYrLuAGacDAZw'

Example response

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

{
  "id" : "36d9ef9c-c535-4978-aa98-5730cc5e1460",
  "domainId" : "2a5ea952-b314-4e2c-89fd-632cc6c76fc9",
  "name" : "Test Type",
  "code" : "test-type",
  "createdBy" : "7a09d918-685e-422b-bb6e-0f8de9d50dbd",
  "createdAt" : "2023-11-29T13:33:31.660188Z",
  "updatedAt" : "2023-11-29T13:33:31.660188Z",
  "root" : true,
  "parentId" : null,
  "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

The id of the domain within which this {@link ResourceType} exists.

Must not be null.

name

String

true

The human friendly name of this {@link ResourceType}.

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

code

String

true

A unique value (within the domain) that can be used by code as a reference to this resource type. These values should almost always be the simple type name of the resource class, such as "BillingAccount".

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link ResourceType} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link ResourceType} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

root

Boolean

true

parentId

String

true

Returns the id of the parent {@link ResourceType} or null if this is a root.

depth

Integer

true

Returns the depth of this {@link ResourceType} within the tree, where a root {@link ResourceType} has a depth of 0.

childrenIds

Array[Object]

true

Returns the id of {@link ResourceType}s that are children of this.

_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiI1Zkl0NUZ1RXZHS3pJRWJwU0JSOG9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRkMWYyNWE2LTYwOTYtNDJkMS1iZjNjLWM2YTNkN2I2ZDQyYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMSwiZXhwIjoxNzAxMjY4NDIxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGIwZGYzYTItMjIwMy00YTg1LTk5YTktZjkyYzM1MDFhNWRlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIxfSx7XCJpZFwiOlwiMDIwMTFmNjItYmZmMi00MGQ0LTkzOGQtYmIwYzk4YWZiZTNkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIxfSx7XCJpZFwiOlwiZGI2MjA2MjctMzg5My00OWZiLTkwZGItODZjMDljYzdjYjNhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fvThRx7KSdtxHkM9J9vB4YaMDUmZufiFFpmQCNEWMCN5rWpgbZg8O6GP_GsBaAI64aXXE7iUg8wmWk5J_PDKu_k5Fz04ghYwzqwpIDJvcQkegQZHqM0tbjhJwqXZuJcgWPkfBiIFo_9ERjShWFrSeHIp-ZJ2zz_RwKtmGIzPUuZD3SW_u6Sd3yrwtEuU_-zjMF26l18G_yZ88rX0kdVroxTSbSN63Osn6gGFh5O0E54E9kEpY_kO7WVD-Te_uAN6jz6DTOrsRm4McENVZvHxEz5D4oAg5Ozd4ND7Ng6iI9M-_280dkaSiizKolqgMYVax1PYZWM2ygvMGmktEMNWgw' \
    -d '{"domainId":"2a5ea952-b314-4e2c-89fd-632cc6c76fc9","parentId":"36d9ef9c-c535-4978-aa98-5730cc5e1460","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" : "5c58f8fc-2f96-4321-b82e-f1114d101ee3",
  "domainId" : "2a5ea952-b314-4e2c-89fd-632cc6c76fc9",
  "name" : "Another Test Type",
  "code" : "anoter-test-type",
  "createdBy" : "dd1f25a6-6096-42d1-bf3c-c6a3d7b6d42b",
  "createdAt" : "2023-11-29T13:33:41.086740Z",
  "updatedAt" : "2023-11-29T13:33:41.086740Z",
  "root" : false,
  "parentId" : "36d9ef9c-c535-4978-aa98-5730cc5e1460",
  "depth" : 1,
  "childrenIds" : [ ],
  "_title" : "Another Test Type"
}

Resource Actions

Find Resource Actions

GET /resource-actions

Returns a set of {@link ResourceAction}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

specified. {@link CustomRole}s. Only non-deleted {@link CustomRoleAction}s are considered. {@link StandardRoleType}s.

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

Filters results to those matching one of the specified codes.

resourceTypeId

Object

true

Filters results to those that apply to one of the ,{@link ResourceType},s specified.

domainId

Object

true

Filters results to those that are in one of the specified ,{@link Domain},s.

customRoleId

Object

true

Filters results to those that are granted by one of the specified ,{@link CustomRole},s. Only non-deleted ,{@link CustomRoleAction},s are considered.

standardRoleTypeId

Object

true

Filters results to those that are included in one of the specified ,{@link StandardRoleType},s.

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].resourceTypeId

String

true

The type of resource that this {@link ResourceAction} applies to.

Must not be null.

[].name

String

true

A human friendly name for this action. This should be a verb only, such as "Create", "Grant", "Remove", "Activate", "Update", "Delete", etc. This can contain more than one word, and spaces are permitted and encouraged if more than one word is present. Words should be initial-caps. This value will be appended with the names of other entities, such as a resource type name, in order to compute names for the composition of this with another entity. For example, if this action is "Create" and it is composed with a resource type named "Network", then the resulting composition may be named "Create Network".

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

[].code

String

true

Used by code as a reference to this action. These values should almost always be a simple verb such as "create", "update", "grant", "fetch", etc. Lower-case and hyphen separation of words is encouraged. Since this is used by code, the key value have a limited alphabet of letters, numbers, and hyphens. This value must be unique among the set of {@link ResourceAction}s targeting the same resource type.

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

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link ResourceAction} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link ResourceAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJzUlo3QmJyWW9KbUpTMXlDUFF1aldnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQwN2E1ZGE2LTA2N2YtNDM3NS04ZDVjLWZmNzg4ODRkYjVkMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDE2ZjNjNTMtY2NhMi00MGY4LTk4ODktN2I2YjEwMjI3YjA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ja1LRXpZXpuTCAv8JM0kgOkq83aJXtS6ixAMjOloN0kSQ2M3_heUOYRR3rNRggJ-2MXVVaHPzDnck7eh_KIWNFnoj-hViM4pbZeA6FlZnz5mnzJ4v5yl4dCFA2dGiQdMOf0v7qFiBKmpSjn3sN3F2JiaaqlmMKckaL8wrEpaQPbMflG4ZLjUvWwp_iwpWDvXsvGgPi2blatd8Zcrkpcp93KvcpxtRajFOLROtj6kzfWNmJtgd4MIlcBu0-Dmx3L6cPB-LN_rnGUawpkNjAAjHIpMI83CjjajTiqHZa80z-V9ltnawDjMkueNEc6whsRFXEfN7aKBuc1XBET9eehAAg'

Example response

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

[ {
  "id" : "bcba91dc-e105-49c9-a152-ddcfb0ad3e26",
  "resourceTypeId" : "a7e94be5-59b3-427b-8881-511a1766a22e",
  "name" : "Read",
  "code" : "read",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:26.141515Z",
  "updatedAt" : "2023-11-29T13:33:26.141515Z",
  "standardAction" : true,
  "_title" : "Read Customer Resource Assignment"
}, {
  "id" : "d84eab45-eeae-4061-ae75-181b91dcb9ef",
  "resourceTypeId" : "472f7c7d-5e1b-49cb-95d9-4d65e11c4cc1",
  "name" : "Read",
  "code" : "read",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:22.498858Z",
  "updatedAt" : "2023-11-29T13:33:22.498858Z",
  "standardAction" : true,
  "_title" : "Read API Account Identity"
}, {
  "id" : "927e8540-0b41-42be-8177-a3ee10b74d4f",
  "resourceTypeId" : "b40f88a5-e663-499f-af76-ee00a6dd95a9",
  "name" : "Create",
  "code" : "create",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:26.868335Z",
  "updatedAt" : "2023-11-29T13:33:26.868335Z",
  "standardAction" : true,
  "_title" : "Create Root Certificate"
} ]

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

The type of resource that this {@link ResourceAction} applies to.

Must not be null.

name

String

true

A human friendly name for this action. This should be a verb only, such as "Create", "Grant", "Remove", "Activate", "Update", "Delete", etc. This can contain more than one word, and spaces are permitted and encouraged if more than one word is present. Words should be initial-caps. This value will be appended with the names of other entities, such as a resource type name, in order to compute names for the composition of this with another entity. For example, if this action is "Create" and it is composed with a resource type named "Network", then the resulting composition may be named "Create Network".

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

code

String

true

Used by code as a reference to this action. These values should almost always be a simple verb such as "create", "update", "grant", "fetch", etc. Lower-case and hyphen separation of words is encouraged. Since this is used by code, the key value have a limited alphabet of letters, numbers, and hyphens. This value must be unique among the set of {@link ResourceAction}s targeting the same resource type.

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link ResourceAction} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link ResourceAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

standardAction

Boolean

true

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/resource-actions/ba5b4716-dfa9-4709-8995-f3b1d29efc7c' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJsc3VFTU1KV3dvNS1EX1lNYkRVQWZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc5ODA5N2Q5LTFiMTgtNDMxMC05YzlhLWY2ZGZjOTA1OGQ0YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmJmODQ0NGQtYzgwMi00ZGQwLWFkYTktNGI2ZDdhMDAxYzI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DFzU1iR3XBDesddVj-AE5Rb6X2qXvVEwySSe_NjQ2WZGNMzx7VcoTLerMLZUTzgvy-gqvE99DVSyJ4XgUWtKEcRl7jYurmlNUCCHKACnSYOqgxMLNmrC-uCNqMrHzVXq95o492AFvpfeNpJIhaeFNmZpxePEDINe0GvaeS0v2R-lulsNP-1lLKu4z8j9IVYomvMzMxzrKWIbQQtEx2xSOTTGdrYHLuqWKTXQhiIsDS9f-GLtQOQxQzOeX7V3-jWUPKQUpXDuUmY913Dj7NA-tpEH1cXZim7jiSAtYQ8wizhMS7JWZwzt4ETZyU838E4U-oXgP5EXtMWtttjOUX1INQ'

Example response

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

{
  "id" : "ba5b4716-dfa9-4709-8995-f3b1d29efc7c",
  "resourceTypeId" : "36d9ef9c-c535-4978-aa98-5730cc5e1460",
  "name" : "Test Action",
  "code" : "test-action",
  "createdBy" : "871c83c7-7ef9-4601-9bd8-4758aee7aec3",
  "createdAt" : "2023-11-29T13:33:31.675645Z",
  "updatedAt" : "2023-11-29T13:33:31.675645Z",
  "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

The type of resource that this {@link ResourceAction} applies to.

Must not be null.

[].name

String

true

A human friendly name for this action. This should be a verb only, such as "Create", "Grant", "Remove", "Activate", "Update", "Delete", etc. This can contain more than one word, and spaces are permitted and encouraged if more than one word is present. Words should be initial-caps. This value will be appended with the names of other entities, such as a resource type name, in order to compute names for the composition of this with another entity. For example, if this action is "Create" and it is composed with a resource type named "Network", then the resulting composition may be named "Create Network".

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

[].code

String

true

Used by code as a reference to this action. These values should almost always be a simple verb such as "create", "update", "grant", "fetch", etc. Lower-case and hyphen separation of words is encouraged. Since this is used by code, the key value have a limited alphabet of letters, numbers, and hyphens. This value must be unique among the set of {@link ResourceAction}s targeting the same resource type.

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

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link ResourceAction} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link ResourceAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJtcTREeXdvbFI1Umx5eGVKYlZ5OXl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlOGIxZmU5LTMzZmUtNDQyZi1hNWVjLTFjMWQ1MDAzYzdiOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiN2NjOWNiMTEtMzFlNy00YzMzLTgyNGQtMmU5YTAwODAxMjhjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fSx7XCJpZFwiOlwiMjJlMDk5ZWMtNTZkZS00OTIwLWFkYzctMzg4MmQzYjZmZTFjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.cwYk-9jDbyoPy25feeFhKrDqoa2YBMY7hd71Y3apPXmZjLA5KM5BbUWVa667p4gkXtTCWIiBFumG0z44z001dlc6GbBlaI1F2xJ_-NDThpcZeg-s3Mr3sOWEnsUZphgFTfxE5v-AhogLg3fQm-hBpc4IzbQj4qR6i1x8orSqMXTvrhg4LG1pipzVVrhp_XYj9qsIUAaXSqqf44zX1WXEtaqJWImD96bT9dXkT27jM_dOCXhaJSH3orrXOpBBEffStqodFE2LTdalWXQIE1msSDQFQnFSvfyOvwmn8xAt1-12xW7V_4UESIoDK_NVQMVtyq8VXBOskBW1AfZ3Lziw2A' \
    -d '{"resourceTypeId":"36d9ef9c-c535-4978-aa98-5730cc5e1460","actions":[{"name":"Update Custom","code":"update-custom"}]}'

Example response

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

[ {
  "id" : "1fd5821c-a947-49c5-972f-2beb9ca442b7",
  "resourceTypeId" : "36d9ef9c-c535-4978-aa98-5730cc5e1460",
  "name" : "Update Custom",
  "code" : "update-custom",
  "createdBy" : "6e8b1fe9-33fe-442f-a5ec-1c1d5003c7b9",
  "createdAt" : "2023-11-29T13:33:39.532186Z",
  "updatedAt" : "2023-11-29T13:33:39.532186Z",
  "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

The concrete type that this virtual {@link Grant} is based upon. Never null.

Must be one of [CustomRole, IdentityResourceAction, PublicGrant, SuperUser].

[].grantId

String

true

The id of the concrete grant resource on which this virtual {@link Grant} is based. If the grant type has separate resources for the grant and the privileges, then this will reference the grant resource (the resource with an identity id.) Never null.

[].privilegeSourceId

String

true

The id of the concrete {@link PrivilegeSource} from which this grant is based. Some grant types combine the grant and privilege aspects into a single resource. For example, a {@link SuperUser} is both a grant (it specifies an identity id) and a privilege source. In other cases, such as a {@link CustomRole} and {@link CustomRoleGrant}, they are separate. When they are the same resource, this value will match the grantId value. Never null.

[].identityId

String

true

The identity id of the holder of this grant. Almost never null, with the one exception of a grant made to all users (or all authenticated users.).

[].privileges

Map

true

The set of privileges that this grants. These are organized as a stack of 3 Maps where the keys are the domain code, then the resource type code, then the action code, and the leaf value is a set of paths on which that action can be performed.

[].createdBy

String

true

The identity id that created the grant.

Must not be null.

[].createdAt

String

true

The date-time at which the grant was created.

Must not be null.

[].deletedAt

String

true

The date-time at which the grant was deleted. This will be null for an grant that has not been deleted. If this property is not null, then the grant is 'marked' as being deleted.

[].deletedBy

String

true

The identity id that deleted the grant. This will be null until the resource is marked deleted.

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/grants' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJoRm9nOE0zVFJQNVdlbUF1TUNZT093IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZiOTkwYzk5LWEzZGUtNDRiNS1iYzJkLTU0MDM0NzI3N2I5ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNSwiZXhwIjoxNzAxMjY4NDE1LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImI5Y2Y5MmZjLWFhZGEtNGEwZi1hOTRhLTNkODYxZDFlYjE3ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxNX1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiMTFhMTM0MDYtZWQyNS00NjVkLTlkOGYtZmRmM2U5ZmZjMjhkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiYjAzMjU4NzItNTUzZi00NDM3LTgzODAtZDRkZTY2ZDdhOTgyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA2fSx7XCJpZFwiOlwiZjY1ODFjYzMtNjIyNS00YWEwLWE5ZDgtMDBhM2ViYTE1M2Y4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA0fSx7XCJpZFwiOlwiNGQzNWQ2M2QtMTcxYS00MmU1LWIzYzctNGUwY2EyMGE1Mjc5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODExfSx7XCJpZFwiOlwiOTY2ZjJkNDUtYjdjMi00NDlmLTlhYzYtNjgxN2Q2NzhiMTljXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiOGRhNTI5NmEtMGE4Mi00NDU0LWJiZmQtYmE4NTk1YjZkY2FkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiYjAyMzkxYjEtYjIxZC00OTUxLTk1ODMtMmY3ZDc3MjczMmIxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODA0fSx7XCJpZFwiOlwiMDg0ZmRhZTAtZDJkOS00NmQ5LTgxM2UtNzFjOGE1OWQxNDRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiY2FmM2Y2YTctZTI5Zi00ZDA3LTgwYzktMmY1OWU2OWQ5YjQ2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfSx7XCJpZFwiOlwiODk1NmNiMjYtYmZkYi00ZGViLThjZmEtYWJiNmE3ODJlYjRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODAzfV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.oU4Y9n94AR4xD0fq9ew-i21hKcOmP4oFI91wR0-XTCuFtdWbYAf_7bUOAVfl58CQMJGAK8wtkJN_0DorUuCBnEIB5KJGJJDJF2p7H8UDrhx4e2BgRxM9l7uHX1Vxjy5VUQ8IB-synk8GddGTT7wpzMqNS8W6B1iMa9ImSQP5aDFXhjbumMpbgBCRuWXARHvSqZsIN1Ocz4lNcxYrwD8gc2flODDmmffZ44vB20aGL1OdE56c9_U4NimGiOkv8_JIueef4EWkYre91v-Ty2N0d6Wg5JcYBWexFlE6MHjdfOAb7NUTiDPMqF8wSJYiCuM_oenLaZPeugHwnvAFpuS3Kg'

Example response

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

[ {
  "grantType" : "IdentityResourceAction",
  "grantId" : "29419de3-55c2-4689-bcad-c0fe0b35ba55",
  "privilegeSourceId" : "29419de3-55c2-4689-bcad-c0fe0b35ba55",
  "identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "privileges" : {
    "io.netfoundry.network" : {
      "container" : {
        "update-suspend" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:27.248031Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Suspend Container, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
}, {
  "grantType" : "CustomRole",
  "grantId" : "01f971d3-00e6-46c2-a87b-ca4ddb0cbc16",
  "privilegeSourceId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "identityId" : "fa06a740-21f8-480a-9e7a-1f759b506e0b",
  "privileges" : {
    "io.netfoundry.auth" : {
      "custom-role-grant" : {
        "read" : [ [ ] ]
      },
      "identity-resource-action" : {
        "read" : [ [ ] ]
      },
      "public-grant" : {
        "read" : [ [ ] ]
      },
      "standard-role-type" : {
        "read" : [ [ ] ]
      },
      "domain" : {
        "read" : [ [ ] ]
      },
      "custom-role" : {
        "read" : [ [ ] ]
      },
      "custom-role-action" : {
        "read" : [ [ ] ]
      },
      "super-user" : {
        "read" : [ [ ] ]
      },
      "resource-type" : {
        "read" : [ [ ] ]
      },
      "action-inclusion" : {
        "read" : [ [ ] ]
      },
      "standard-role-grant" : {
        "read" : [ [ ] ]
      },
      "resource-action" : {
        "read" : [ [ ] ]
      },
      "standard-role" : {
        "read" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:24.652750Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read-Only, ALL Auth Domain Resources to identity fa06a740-21f8-480a-9e7a-1f759b506e0b"
}, {
  "grantType" : "IdentityResourceAction",
  "grantId" : "2b9a6625-2d03-4862-88da-bec8681b787b",
  "privilegeSourceId" : "2b9a6625-2d03-4862-88da-bec8681b787b",
  "identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "privileges" : {
    "io.netfoundry.network" : {
      "network-backup" : {
        "read-network-backup" : [ [ ] ]
      }
    }
  },
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:26.765315Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read Network Backup Network Backup, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
} ]

Super-User Grants

Find Super Users

GET /super-users

Returns a set of {@link SuperUser}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

{@link Domain}s. To search for {@link SuperUser}s that explicitly grant access to all domains (ie, the domainId is null), include this query parameter with no value. only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to those that grant to an identity specified in this set.

domainId

Object

true

Filters results to those that grant access to one of the specified ,{@link Domain},s. To search for ,{@link SuperUser},s that explicitly grant access to all domains (ie, the domainId is null), include this query parameter with no value.

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].identityId

String

true

The id of the identity to whom super-user access has been granted.

Must not be null.

[].domainId

String

true

An optional {@link Domain} id, which when set indicates that this super-user is limited to {@link ResourceAction}s in the corresponding {@link Domain}. When not set, this super-user applies to all {@link Domain}s, present and future.

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link SuperUser} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link SuperUser} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link SuperUser} was deleted. This will be null for an {@link SuperUser} that has not been deleted. If this property is not null, then the {@link SuperUser} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[].type

String

true

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/super-users' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJkWTE1cXR2SVl4cTNUYjVwNmZUbGhnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZkM2EyMjg1LTQzM2EtNGJhOC1iZGQyLWE4NzQwMDIxYmM3ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDZhZGNjZjYtMGE0Ni00MzM5LThmMzktZTVjOWI4YTYzNzFmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.BajxF-5kLHZAG38BYm4K4D64QhUc_pWPcPJfIs7b9GG0sDfZrZRspzryfYwfDocTOiFiIxC6O7VlXHiEShjfjYC1I5w1Iy3wak-Zt-JruVgEsonu9GCJ11TO7NnzFck1bVauPcbkq6G4Xk4WSPc4PJlNL7fX3y9ryWuKuDI6Kpzv83gDQn5Ou4ItpYhYqnz7Zk5fY_l6lM8YA5GhMeUQH2RWdPySV5p7kmHYLsBR5n2ficSWFGuJOaRyKR2Xsx501clNLfYs4b9w_d_j2loc0Sl9IgWXXTYPpSIv80TqolLlX-cxRITeXfoTaiqPJN4WA5FWO2Pj-LuhTL78zjZpXw'

Example response

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

[ {
  "id" : "3548f5f9-d870-4a96-ac7f-df163e04ef96",
  "identityId" : "191810ec-83f1-47d4-9580-3cc8bc2f6f0d",
  "domainId" : null,
  "createdBy" : "ee470027-0d9d-4ad4-b3d5-f8dbef3a720c",
  "createdAt" : "2023-11-29T13:33:40.610168Z",
  "updatedAt" : "2023-11-29T13:33:40.610168Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 191810ec-83f1-47d4-9580-3cc8bc2f6f0d"
}, {
  "id" : "5a7915da-e443-410e-a1fe-1237a209883b",
  "identityId" : "191810ec-83f1-47d4-9580-3cc8bc2f6f0d",
  "domainId" : "2a5ea952-b314-4e2c-89fd-632cc6c76fc9",
  "createdBy" : "61ac2ac5-c167-41b4-ba58-f7c674b32eb9",
  "createdAt" : "2023-11-29T13:33:31.686614Z",
  "updatedAt" : "2023-11-29T13:33:31.686614Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in Test Domain to identity 191810ec-83f1-47d4-9580-3cc8bc2f6f0d"
}, {
  "id" : "8d3a9472-c382-4fe3-93c2-9c19beb7b516",
  "identityId" : "1971393e-f932-432e-8206-bd6864b49293",
  "domainId" : "475a3760-7351-4add-a2e9-20e610b0d5d6",
  "createdBy" : "c4ab7735-8054-4ed6-8a79-bd5a596aa0da",
  "createdAt" : "2023-11-29T13:33:40.720021Z",
  "updatedAt" : "2023-11-29T13:33:40.738214Z",
  "deletedAt" : "2023-11-29T13:33:40.737750Z",
  "deletedBy" : "f1538b2c-0564-4052-a755-167954db71fc",
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in Test Domain 55 to identity 1971393e-f932-432e-8206-bd6864b49293"
} ]

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

The id of the identity to whom super-user access has been granted.

Must not be null.

domainId

String

true

An optional {@link Domain} id, which when set indicates that this super-user is limited to {@link ResourceAction}s in the corresponding {@link Domain}. When not set, this super-user applies to all {@link Domain}s, present and future.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link SuperUser} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link SuperUser} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link SuperUser} was deleted. This will be null for an {@link SuperUser} that has not been deleted. If this property is not null, then the {@link SuperUser} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

type

String

true

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/super-users/5a7915da-e443-410e-a1fe-1237a209883b' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJjR1pRaFRreHQ1ZUpyTXRiSWNqTWZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVhNDUxMjNjLTA1ZGEtNGRhNy04ZTA1LTJiOTJhMzgyY2YwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2IyOTAxNzktYTM1OC00NDIzLTg2NzUtNjgyNjQxYjgyOTAwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.kb-6AaFIzXunYijcNdnCeU6zaMd0250d4HE0doMfOdG5ZRIp8KY_qL9foNEYFSEaBPPxFaGcpeieQG2g5sNskZj66X5bixVIOcqaz7-VH8hteoy_seGXruNX2bEH8LSPgABSYBMwiDnPakM_TV2tfTdvGta_cauP07rXyuoIkRoU-JuxMFuiGtG7YpJMAhIjw_Oha-TOHi4aSXVxiTucsZqbpCf3kTVmbNTwC9GCih-4UzSwp5Sym2_Hx_D1ksiX7aP_WGGjAMS_SWfhC8IIVhMNK6pLapNmfTTYJDvdqYCgyZW6ZM8IsnjdsVrTlsO9eqgxhyQsuEjDGdt2zfwYaA'

Example response

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

{
  "id" : "5a7915da-e443-410e-a1fe-1237a209883b",
  "identityId" : "191810ec-83f1-47d4-9580-3cc8bc2f6f0d",
  "domainId" : "2a5ea952-b314-4e2c-89fd-632cc6c76fc9",
  "createdBy" : "61ac2ac5-c167-41b4-ba58-f7c674b32eb9",
  "createdAt" : "2023-11-29T13:33:31.686614Z",
  "updatedAt" : "2023-11-29T13:33:31.686614Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in Test Domain to identity 191810ec-83f1-47d4-9580-3cc8bc2f6f0d"
}

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

The id of the identity to whom super-user access has been granted.

Must not be null.

domainId

String

true

An optional {@link Domain} id, which when set indicates that this super-user is limited to {@link ResourceAction}s in the corresponding {@link Domain}. When not set, this super-user applies to all {@link Domain}s, present and future.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link SuperUser} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link SuperUser} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link SuperUser} was deleted. This will be null for an {@link SuperUser} that has not been deleted. If this property is not null, then the {@link SuperUser} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJkQUM4a1BfRjFqWmlZQWdYY1dTaFp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVlNDcwMDI3LTBkOWQtNGFkNC1iM2Q1LWY4ZGJlZjNhNzIwYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjYwYzk2NDktNWI1MC00ZjA1LTgxNGUtM2I0ODZhMDgwZjBhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfSx7XCJpZFwiOlwiOGE5Y2IyZjUtODNhNi00Y2Y1LWE4ZDAtMTQ2YWMyNGI5ZmVhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.UwN6UsqYKsT9G9rDzXdQ1C0dR-Xf2FEyRgASO4-m5DwtyH7CXGK0bPTr18BnOcQ11Y-GR-OcN86FKEI70d5Say9KsIZvYtx-HpWgOu5jMHczmDA7kxIlsHhFJBBooss-ZWZSZ4nRDwqZp3EwLDm5uC1EDT8gFc8GI7vKji-K89D4MJgVHGJoEyXewPOHn6I4oeRrCXsdZK3sSAnwuf0TvYtwad1cKMyrMU3KCAkPY7P5561mrDoaV53ipDlvqWtWSr3OCWiC0w6gkWuiYZx-RRAUmismb4RTFNs2fA1elu5pecq0vQhkOqmSeqdwZPVd3g5oPGrkyHQ-Y4hosU00-Q' \
    -d '{"identityId":"191810ec-83f1-47d4-9580-3cc8bc2f6f0d","domainId":null}'

Example response

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

{
  "id" : "3548f5f9-d870-4a96-ac7f-df163e04ef96",
  "identityId" : "191810ec-83f1-47d4-9580-3cc8bc2f6f0d",
  "domainId" : null,
  "createdBy" : "ee470027-0d9d-4ad4-b3d5-f8dbef3a720c",
  "createdAt" : "2023-11-29T13:33:40.610168Z",
  "updatedAt" : "2023-11-29T13:33:40.610168Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
  "_title" : "Grant All Actions (SU) in All Domains to identity 191810ec-83f1-47d4-9580-3cc8bc2f6f0d"
}

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/8d3a9472-c382-4fe3-93c2-9c19beb7b516' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJRSW02eEhnQjhkVTJWbFF1MHlZWVRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYxNTM4YjJjLTA1NjQtNDA1Mi1hNzU1LTE2Nzk1NGRiNzFmYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODkzMmU2MzktOGRmNy00ZmYyLWFlMmItZGY4M2Y5ZGNiNWFkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.A8xSy17AbASUe394ZKg486l345KJsC0tUOfaArRtRC5Rgg0IzEYfv9wkcdghsG8u3n1EqI6b1RQglLCSAc4CHjHOJ3DQq68Y2230tStgUszbx0ymMj2SxPfqYZfKFf2hE1zidXIUKyp51TGbIs1LQMw2xu132U-8Xe_AlIzEqs-1G2b4dyQ7S6fYXvGZLMjhGZmTFzboYF5UK-ob0QvhFECYoc-tUTSmx41r1bcUGUrAUdohEw9H-E7FA2EWCwd_a8gme4rxVUyVYz-PdRSwAC4wpsKbxqqeNECPxCAyQKXlbidZlF3ZpSBtt_P0XnEbawswlDTJJ0lXiD6uMV7okA'

Example response

HTTP/1.1 200 OK

Public Grants

Find Public Grants

GET /public-grants

Returns a set of {@link PublicGrant}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

{@link ResourceAction}s. false, filters to those with the isAnonymous property is false. When not specified, the results will include those with both true and false values for this property. example, if the path is to Network X which is under Network Group Y, this would restrict the results to {@link IdentityResourceAction}s that grant an action on any resource under Network X, an action on Network X itself, or an action on Network Group Y. Combine this query parameter with resourceActionIds to limit the results to the types of actions along the path that are of interest.
The path value must start with a domain code followed by a colon. It may then have a comma delimited sequence of colon separated resource type code and resource id pairs. The path structure must match that of the server defined resource tree for the specified resources in the specified domain. only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to those that grant one of the specified ,{@link ResourceAction},s.

isAnonymous

Boolean

true

When true, filters results where the isAnonymous property is true. When false, filters to those with the isAnonymous property is false. When not specified, the results will include those with both true and false values for this property.

path

Object

true

Filters results to those that target any resource along the specified path. For example, if the path is to Network X which is under Network Group Y, this would restrict the results to ,{@link IdentityResourceAction},s that grant an action on any resource under Network X, an action on Network X itself, or an action on Network Group Y. Combine this query parameter with resourceActionIds to limit the results to the types of actions along the path that are of interest.,
, The path value must start with a domain code followed by a colon. It may then have a comma delimited sequence of colon separated resource type code and resource id pairs. The path structure must match that of the server defined resource tree for the specified resources in the specified domain.

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link PublicGrant} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link PublicGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link PublicGrant} was deleted. This will be null for an {@link PublicGrant} that has not been deleted. If this property is not null, then the {@link PublicGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[].path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link PublicGrant} targets.

Must not be null.

[].path[].resourceId

String

true

Must not be null.

[].path[].resourceTypeId

String

true

[].anonymous

Boolean

true

If true, then any client may perform the linked action even if not authenticated. If false, then a client must be authenticated in order to perform the linked action. The actual identity id of the client does not matter for {@link PublicGrant}s.

[].type

String

true

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJGQjBjMUF6N3B6bFdGQzFGWEI4c0t3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU0MGMzMzY0LTUyYjItNGRkOS1iMWYxLTU4ZTc1ZTY2MGRiNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjkxODBhMDUtZmU3My00NjU3LWFmNzgtNDYyNGI2YWI3NzRlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.g0TxWcociHJ4Qcn50BIyivj35sC9PyBY9Plx09LKZfzqOYdGBUBLIVWXu6QxCaFxfjmJmj4XWitr41sEm2KCHotKaFZLHvZQFHEF2F8MFUsUkZuhJno_zDSWfgine-Gsgh--gWas3qLg506g6V7iTpR0Cboza5-tw7tOSMMFUSepkOLWbPydJjdTq3FNe9FmOK1FygNpqcujEUfy0QY4PH6gwBfgzoHe5lEqA-jAFVLA6YkpZiWkLlDfh9XALXMkcvuLtslsehLX3ExELTN6IVYaYjpyhuQbTQ4kuD7DqocYnCXMuOkkKlz4w_LRyLYtjhJj0oXA-NT-7_LHwmz_nQ'

Example response

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

[ {
  "id" : "b02391b1-b21d-4951-9583-2f7d772732b1",
  "resourceActionId" : "bfaaae11-ff89-42bb-b45a-07c411531142",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:24.399694Z",
  "updatedAt" : "2023-11-29T13:33:24.399694Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Read Workflow Status, All to All Authenticated Clients"
}, {
  "id" : "084fdae0-d2d9-46d9-813e-71c8a59d144f",
  "resourceActionId" : "542c43cd-c83e-4620-804d-c159d03ebf21",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.033455Z",
  "updatedAt" : "2023-11-29T13:33:23.033455Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Read Geo Region, All to All Authenticated Clients"
}, {
  "id" : "11a13406-ed25-465d-9d8f-fdf3e9ffc28d",
  "resourceActionId" : "01a80f61-3191-446e-a6e0-4fd5f934caa2",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.716911Z",
  "updatedAt" : "2023-11-29T13:33:23.716911Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Read Network Configuration Metadata, 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

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link PublicGrant} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link PublicGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link PublicGrant} was deleted. This will be null for an {@link PublicGrant} that has not been deleted. If this property is not null, then the {@link PublicGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link PublicGrant} targets.

Must not be null.

path[].resourceId

String

true

Must not be null.

path[].resourceTypeId

String

true

anonymous

Boolean

true

If true, then any client may perform the linked action even if not authenticated. If false, then a client must be authenticated in order to perform the linked action. The actual identity id of the client does not matter for {@link PublicGrant}s.

type

String

true

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/549bb878-a8d3-44c0-ba4c-11c0825d56b5' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJ1dUVZZkpLcTZWLTh1bHZSRGRyYVd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFiY2U1ZDRkLWM4OWUtNDhjNy04ZTViLTQyZWVhNGM4YTk4MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNzIwODRhNGYtM2RlZC00NzZkLWE2MzMtNTUzY2I0YzI3OTJhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.D94InLHRIhP2_ojP3BESFf566UOH0OCR8-R0ANtJ0b-qpBkG2Z_MkPe2M1RLj5_t6gER3TrVVoB83UYpluSGWZs4OBGigHRrjiQ16SwnoXJXs06a28hc2fIFH_PADuzhVp-r_86YrLj1Haq7QJgCEQfmGhTsPyMAhrreRA3sJ8d8SJch0Se4df_lBaLL3bFIdLZ03npaegV2uyGopMvjKxgRi5hZQ7utIrtOn7italVtTcbPejjrGSFSMh96eyzQ-ABREMQlwHaFOZBfOymcRUPFBDqER1vP6HYwyO00QkY1kUtbaaFqE7t9855g2sTA5FiORhqt3DaAB1iVAur7kg'

Example response

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

{
  "id" : "549bb878-a8d3-44c0-ba4c-11c0825d56b5",
  "resourceActionId" : "339a7714-a2a9-4657-b214-cc004f826280",
  "createdBy" : "c8a122e7-7d19-44ae-b274-0f92d2f79d2f",
  "createdAt" : "2023-11-29T13:33:39.034382Z",
  "updatedAt" : "2023-11-29T13:33:39.034382Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "52cc2bc3-c16b-4519-93fb-7d94a675090d",
    "resourceTypeId" : "ff0d3b05-bc79-456e-9ace-c04087357198"
  } ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Test Action 45 Test Type 44 on/under Test Type 44 52cc2bc3-c16b-4519-93fb-7d94a675090d 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

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link PublicGrant} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link PublicGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link PublicGrant} was deleted. This will be null for an {@link PublicGrant} that has not been deleted. If this property is not null, then the {@link PublicGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link PublicGrant} targets.

Must not be null.

path[].resourceId

String

true

Must not be null.

path[].resourceTypeId

String

true

anonymous

Boolean

true

If true, then any client may perform the linked action even if not authenticated. If false, then a client must be authenticated in order to perform the linked action. The actual identity id of the client does not matter for {@link PublicGrant}s.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJhaTNER25pdms3a18xR3lERGdCdi1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhkN2E0OWZmLWUxZGEtNDVjMS1iNzM5LWRiYmZiMDUwYWQ4OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWRiNjAzNGEtYTg5Ny00YmE5LWI4MTAtYmVhYWFlMTgwMGY1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fSx7XCJpZFwiOlwiZGNjZTYyZmMtMGEwMi00OWNlLWI2MmUtNDc5NTJjNzNjNTQ4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Kz2TLslg4tQfdxoB6mGRC45REkcCCZtQ0fZ6URQ4O9hD_Q1iARRwc9So2oqQXZj7uzR0b909iihaWFuIrIThfvAO_iyVs5iLYoPM-ZBSHuhA3bJjI4OTnEq1-D-kZQKCRzSH4HSGiNQCJWRSYZFrakCcUyYjw3h5nSq1esxOI0xmEPGz5ohMMn6I-AH_qKdLVstY0N4HbpqCKJ2MogqMdmotf1CRReNu0206DXJfz-EP1AcVUNvQlF2Cj_P2pv14HdiUCOlwuZDVvS0feCuFAXstSDbTrU_maGlUKT3VKFW4UDMV3j5nH70IG52aUEq5QAlzyrbC94845XN8yKzgpg' \
    -d '{"resourceActionId":"ba5b4716-dfa9-4709-8995-f3b1d29efc7c","path":[{"resourceId":"94590f4b-c5e7-49da-ad39-cf57dd4e65a3","resourceTypeId":"36d9ef9c-c535-4978-aa98-5730cc5e1460"}],"anonymous":false}'

Example response

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

{
  "id" : "ccdd1080-2b38-4b21-8a22-2ead973ea404",
  "resourceActionId" : "ba5b4716-dfa9-4709-8995-f3b1d29efc7c",
  "createdBy" : "8d7a49ff-e1da-45c1-b739-dbbfb050ad89",
  "createdAt" : "2023-11-29T13:33:39.283896Z",
  "updatedAt" : "2023-11-29T13:33:39.283896Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "94590f4b-c5e7-49da-ad39-cf57dd4e65a3",
    "resourceTypeId" : "36d9ef9c-c535-4978-aa98-5730cc5e1460"
  } ],
  "anonymous" : false,
  "type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
  "_title" : "Grant Test Action Test Type on/under Test Type 94590f4b-c5e7-49da-ad39-cf57dd4e65a3 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/0e313323-f265-43b8-9505-566d726bcafc' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJtWEI5eGNPZUQwRWpFS3pRc3NIOUpBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU0ZTg3MzQwLTAxMjYtNDA1MC04OTUwLWJmZGJmOWY4ZTA5MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjBlMzEzMzIzLWYyNjUtNDNiOC05NTA1LTU2NmQ3MjZiY2FmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzY3NjMwMTItMWE2MS00NzM4LWFlZjctZjY5YjkyYWIzM2MzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.sqUP4v1BJJux_S7z31frM7HyZ99zFkO2XxG-eM1U436gtA4D4eE2klACZc3qVUqRmOtxvuKQvk_yZenlZfCkLx0fFIu5CihPCtdn-ef_U2Wgr4Pd0h3o8jvoWwVio-biK6i-WRs7Beqqj8TjJLbOgr-lT0bBikRzcBkI0WmMbtV7w3B3VA8NP1io4csQkhBfEmulZhiXWpHds3Jjuis1n0FWfsdq7ZX14qcPSZpXtvsT94xAM3-d1Cq_3yfSKHWxKBkEkQewCvtqUGmsAbaGulQG0jHZtQs4dDzpwdEqtUojs2K9yjbLR6OLXyk59jDZhEKKuQ6PCoTJFz_WiptHBw'

Example response

HTTP/1.1 200 OK

Identity - Resource Action Grants

Find Identity Resource Actions

GET /identity-resource-actions

Returns a set of {@link IdentityResourceAction}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

{@link ResourceAction}s. For example, if the path is to Network X which is under Network Group Y, this would restrict the results to {@link CustomRoleAction}s that grant an action on any resource under Network X, an action on Network X itself, or an action on Network Group Y. Combine this query parameter with resourceActionIds to limit the results to the types of actions along the path that are of interest.
The path value must start with a domain code followed by a colon. It may then have a comma delimited sequence of colon separated resource type code and resource id pairs. The path structure must match that of the server defined resource tree for the specified resources in the specified domain. only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to those that grant to an identity specified in this set.

resourceActionId

Object

true

Filters results to those that grant one of the specified ,{@link ResourceAction},s.

path

Object

true

Filters results to those that target any resource along the specified path.,
, For example, if the path is to Network X which is under Network Group Y, this would restrict the results to ,{@link CustomRoleAction},s that grant an action on any resource under Network X, an action on Network X itself, or an action on Network Group Y. Combine this query parameter with resourceActionIds to limit the results to the types of actions along the path that are of interest.,
, The path value must start with a domain code followed by a colon. It may then have a comma delimited sequence of colon separated resource type code and resource id pairs. The path structure must match that of the server defined resource tree for the specified resources in the specified domain.

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].identityId

String

true

The id of the identity to whom this {@link IdentityResourceAction#resourceActionId} has been granted.

Must not be null.

[].resourceActionId

String

true

The {@link ResourceAction} that possession of this {@link IdentityResourceAction} grants to the linked identity for resources under the specified path.

Must not be null.

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link IdentityResourceAction} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link IdentityResourceAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link IdentityResourceAction} was deleted. This will be null for an {@link IdentityResourceAction} that has not been deleted. If this property is not null, then the {@link IdentityResourceAction} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[].path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link CustomRoleAction} targets. For example, if this {@link CustomRoleAction} is "Update Widget Service" then this property defines the (id) path of/to the "Widget Service" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to the {@link ResourceAction#getResourceTypeId()}. Both must target the same {@link ResourceType}.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJHX0FWaXN0Sl9DR20zRTRXUHlHeFlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk4YTFhOTJlLWUyOWQtNDlkMy05OGYwLWQ4NjYxOTg1NjA2MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNCwiZXhwIjoxNzAxMjY4NDE0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjAwYjhiMWEtNDk5Yi00NmJlLWI2OWItZWU5MzAwMDk1YjJhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZMYUxZ0TK3s_SUJymjwtDyqVBEgMhQndqpTMKf8mt6EVzCf3bLP6mg13_cqDTHVnFOZiLKJSWQ4WteHN1_vi0Gbk96EGD83MwvKtirF9E0pCxqCN2PRsDtgWKlrAW2qcgMh8cbJqdIcn-bg3cwBBsMVenyB7QjJPF3ON9tROaRNk4D4PmmDMS8g6yzzdPlCgT3BorF3clQoG_FlbD05-hhHRSC_pbq2XoYXCY_htPticeQFwSb3LS9g_TTi-FXjuOxf1vC49lH_3qOoB7bgTNfaktikhB_QLmvFIRv7i-1W-hJS7Mq0duvcaL1PQADJDlfj0G8HNgRiydXDRNjGZWg'

Example response

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

[ {
  "id" : "ab41bf3a-6750-4bfd-930f-a8677c4b4fd3",
  "identityId" : "0ed768fa-7214-4404-8335-a715156dff45",
  "resourceActionId" : "a4a4a0a5-5219-4d4c-be74-c1920b871fb3",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:24.869728Z",
  "updatedAt" : "2023-11-29T13:33:24.869728Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Read Transfer Node Pool, All to identity 0ed768fa-7214-4404-8335-a715156dff45"
}, {
  "id" : "4ebf6db7-54ce-4835-a125-461cb97b45ed",
  "identityId" : "0ed768fa-7214-4404-8335-a715156dff45",
  "resourceActionId" : "0feee21f-0816-42d9-bf86-47716b89fd33",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:24.869728Z",
  "updatedAt" : "2023-11-29T13:33:24.869728Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Read Transfer Node, All to identity 0ed768fa-7214-4404-8335-a715156dff45"
}, {
  "id" : "a3883f8c-aaa9-42b2-8de6-8d966e0c4026",
  "identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
  "resourceActionId" : "abaa770d-cc5e-48d0-b951-c3e1f12b3c58",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:24.465867Z",
  "updatedAt" : "2023-11-29T13:33:24.465867Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Read Network Group, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
} ]

Get Identity Resource Action

GET /identity-resource-actions/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

identityId

String

true

The id of the identity to whom this {@link IdentityResourceAction#resourceActionId} has been granted.

Must not be null.

resourceActionId

String

true

The {@link ResourceAction} that possession of this {@link IdentityResourceAction} grants to the linked identity for resources under the specified path.

Must not be null.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link IdentityResourceAction} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link IdentityResourceAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link IdentityResourceAction} was deleted. This will be null for an {@link IdentityResourceAction} that has not been deleted. If this property is not null, then the {@link IdentityResourceAction} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link CustomRoleAction} targets. For example, if this {@link CustomRoleAction} is "Update Widget Service" then this property defines the (id) path of/to the "Widget Service" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to the {@link ResourceAction#getResourceTypeId()}. Both must target the same {@link ResourceType}.

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/81611594-a9d9-42f5-b96d-f07653f19ffd' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiIxenp5QnQzYlJFZl9pbWUya1BEMkZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEyMGQ0OTEwLTk0OGItNDhlZC04MGMxLWEwOGE4OWIwMmIwYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNCwiZXhwIjoxNzAxMjY4NDE0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTI5ZDZkZGQtMWJiNy00M2VjLTkxMTAtZmFjOWFlMGM3NjcyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ml4LiYKZ7oTYoljmVu2azpTz-94yiM-BUxXup-G6Y90yAg8vRpXTrZXqJlYkV9IOUSekR1Mg-BIrauiyFX0Yg6ha-X9vQ5kEeyONW6kl6rPwQ38HSJvU6Nl7jgXhfeVl9Q22JjO5rhxeauMSmUgC_tVRcTNCx6J-pnHAeCu-lqrmoNL67seLrNu4CLzjrjI_YE3rOf_o8lAcA0uxa2sx1wuc2Ivd7pVAud6Sz1OexYPVyzS4ASBZbkEs1rebjL-zo8iNgj_EjCiq8fTlOgX_-ohdRRWwlAOZ_cut3cIiC6asNFYFeijK5VQmB7RExPDZD77vGD2EmN9sFrMPaaT2Xg'

Example response

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

{
  "id" : "81611594-a9d9-42f5-b96d-f07653f19ffd",
  "identityId" : "ccc298d6-36d5-4dd8-8cba-ba89ffaaa137",
  "resourceActionId" : "79694e0e-f30a-4bd5-9b7b-0f2733c88f12",
  "createdBy" : "b453d779-45cd-4912-a198-3eee6322d406",
  "createdAt" : "2023-11-29T13:33:34.942643Z",
  "updatedAt" : "2023-11-29T13:33:34.942643Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "160346c4-f82c-4d24-8096-8a24d1ca5cd0",
    "resourceTypeId" : "89e41e46-a974-42cb-90ed-727f1b3adfd1"
  } ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Test Action 5 Test Type 4 on/under Test Type 4 160346c4-f82c-4d24-8096-8a24d1ca5cd0 to identity ccc298d6-36d5-4dd8-8cba-ba89ffaaa137"
}

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

The id of the identity to whom this {@link IdentityResourceAction#resourceActionId} has been granted.

Must not be null.

resourceActionId

String

true

The {@link ResourceAction} that possession of this {@link IdentityResourceAction} grants to the linked identity for resources under the specified path.

Must not be null.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link IdentityResourceAction} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link IdentityResourceAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link IdentityResourceAction} was deleted. This will be null for an {@link IdentityResourceAction} that has not been deleted. If this property is not null, then the {@link IdentityResourceAction} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link CustomRoleAction} targets. For example, if this {@link CustomRoleAction} is "Update Widget Service" then this property defines the (id) path of/to the "Widget Service" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to the {@link ResourceAction#getResourceTypeId()}. Both must target the same {@link ResourceType}.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiIxc0E5ZGxKRzl0UkFkaWpMc05OTEtBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIxZmI2MmNiLTE5YTctNDM5MS04ZjJlLTJjMTc5MDkzNzQ4ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNSwiZXhwIjoxNzAxMjY4NDE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDM3Mjc4NGEtNTdlMC00ZjRkLTg3NWItNDgwYzNjYTY1MTc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE1fSx7XCJpZFwiOlwiMjRjOWQ4NGItN2JlYy00ZWM0LTlhYjYtNzIwYzY1ZDg3MDdmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Xdl-utekZf1M11Uo0HyzWnqeiNuoqDPReXMdsEEUGMJpH4GOrR832I1qUCosrdn3O8Mv0COObPMI5KVfNrBpME9c70awSMdnvqyeu1KKBTBr2k-x6jw6ZunktzA_aBryExcuyO4CiiuswE-osSNSWfqjz8XElyeMZn7YvGL58eknRw6p1flStUKKHClr1ZywgAPM-6MsN5dXSk_pmSLA0dHS3DkZL09FLVccf-OycVKOX3k-dWXfvooc419ocAMbKQOgqrmfbYlAwQ9Qs0_BlbuKWfmzD8spNo_sMPdyi27M73vvp0Baq52T0tF_9D4RMExFgpHpuu3BYQ7xNkmPKQ' \
    -d '{"identityId":"01b6aca3-2175-471a-84be-e47ca55b9b36","resourceActionId":"ba5b4716-dfa9-4709-8995-f3b1d29efc7c","path":[{"resourceId":"b1471354-b9ca-4cbe-8366-482648d15d02","resourceTypeId":"36d9ef9c-c535-4978-aa98-5730cc5e1460"}]}'

Example response

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

{
  "id" : "6e4480c7-7ee0-4b90-bac0-ff5fabb5b246",
  "identityId" : "01b6aca3-2175-471a-84be-e47ca55b9b36",
  "resourceActionId" : "ba5b4716-dfa9-4709-8995-f3b1d29efc7c",
  "createdBy" : "b1fb62cb-19a7-4391-8f2e-2c179093748f",
  "createdAt" : "2023-11-29T13:33:35.176306Z",
  "updatedAt" : "2023-11-29T13:33:35.176306Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "b1471354-b9ca-4cbe-8366-482648d15d02",
    "resourceTypeId" : "36d9ef9c-c535-4978-aa98-5730cc5e1460"
  } ],
  "type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
  "_title" : "Grant Test Action Test Type on/under Test Type b1471354-b9ca-4cbe-8366-482648d15d02 to identity 01b6aca3-2175-471a-84be-e47ca55b9b36"
}

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/cf93dde6-a6d2-499f-bc73-0ebbba262139' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJ0NmhvQm5lY3gzcnJIR3pNTnFpdlh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRiZjNiMjJiLWY3N2UtNGYyNS04MTc1LWU5ZThmY2U2ZjI5OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxMywiZXhwIjoxNzAxMjY4NDEzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGI5MjE0OTQtNjhjNi00ZGNkLTlkOGQtZTRiNmI5ZmFkODhmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODEzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.bWZLsPh420UP0OWBsUQn2HCIMZxFCC-5BrhUdvJzpfdH469i6Xfky2aS6noB1HNrk-yu66sBBtBwu8ghzWO02clSlnaUeF7fD5EQPrGcumI1cw1I8tR7AgiH9t0GDs3UvxbPmxt6V1VVUNDwFffTrxDcy8hxz-m50P2lIbzKpXlJZwtbvmzDleri4IsUaMPtklzzDKGcsJGisAVMWrhhTDoqeAPzh0TTSjbHlEML6KJA-LmELZCavXWmgEsN064BGoDwgCKadBScZzg-FHCJfWn9aU97bOIPRoKKe9NWWcLim1DU4dTqV6hLtkrGZug6nFsOBeBChgrDXV0AHhN-ng'

Example response

HTTP/1.1 200 OK

Custom Roles

Find Custom Roles

GET /custom-roles

Returns a set of {@link CustomRole}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

{@link ResourceAction}s. only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to those granted to one of the specified identity ids.

resourceActionId

Object

true

Filters results to those that grant one of the specified ,{@link ResourceAction},s.

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].name

String

true

The human friendly name of this {@link CustomRole}.

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

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link CustomRole} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link CustomRole} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link CustomRole} was deleted. This will be null for an {@link CustomRole} that has not been deleted. If this property is not null, then the {@link CustomRole} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[].type

String

true

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiI0THZCbF9UeHhwd0luUWZVNVJha1NnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkwNDIxYjMxLWJjMmItNDE2Zi1hYTg0LWMyNzQzZmUxOTE4MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTc5MTM0ODctOTBjYS00YmM1LWEzZjUtNmJkZjBmNzMwOTJkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f8-3Yly_lKnwdUoE8an8Rzq9u7CcazsE7KXJuQ3M0j187M-Rp7bHF1lYyOMRB2J009gfOU9sC7EXXeNi6WRJIJIroS0G90MKRZEP3SSY4EDNl1KApY9RGX0rj7HwZSeUttRBs6dhMAsXffB3aRb_mXi5I9Ztlwmri-E29cUOMDtWKl8zfM_3KwR2HYCsjjGSFVSOFSAcBZEWnwc00VoworXUxn0y_bezj2NFdyBrfjyDJcTDXn1W8n1p31lXuOL0Gm0v15ERWw11ZqXSLd7onk-nD1rMoK0PpPvfYY_Uy9g1u-gLNFMgvL0kfKJYXwgTF1op0-ztxnZ9L4cF_QIRNg'

Example response

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

[ {
  "id" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "name" : "Read-Only, ALL Auth Domain Resources",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.370922Z",
  "updatedAt" : "2023-11-29T13:33:23.370922Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "Read-Only, ALL Auth Domain Resources"
}, {
  "id" : "1d26553c-8b1b-47c3-a46d-5858e27e152e",
  "name" : "Test Custom Role 40",
  "createdBy" : "62618eea-a508-4b52-b54e-1e16eef97de2",
  "createdAt" : "2023-11-29T13:33:38.613169Z",
  "updatedAt" : "2023-11-29T13:33:38.613169Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "Test Custom Role 40"
}, {
  "id" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
  "name" : "NF Support (Read-Only)",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.731615Z",
  "updatedAt" : "2023-11-29T13:33:23.731615Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "NF Support (Read-Only)"
} ]

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

The human friendly name of this {@link CustomRole}.

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link CustomRole} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link CustomRole} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link CustomRole} was deleted. This will be null for an {@link CustomRole} that has not been deleted. If this property is not null, then the {@link CustomRole} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

type

String

true

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles/59633756-e969-41bf-8f44-769b78dccb0f' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJqRm9NUWs4M09zYk9rOEhGMl93dTd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU1ZmVmMzIxLTRhNDEtNGM2ZS1iMGI3LTRkZTQ4MGRiNjA4NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOSwiZXhwIjoxNzAxMjY4NDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzBkOGI3ZDYtY2MxNy00NGIzLThlYmYtNjAwYzdiYjExZWFhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.lwq8Po6Whls_-rCQugO7-ZsIUw4wCByigbl0LQzBcTvli2mAFT5dLHvSXwy-7BvZybKA6bj_4jedzUeTtu-ZNWbruKHBx-vVA5770XD65Z77SsJqiZfMSgEG8uc1DUuDRdWDMTUo4lULn44XKSVxf6xsE7h888Sfxd2dmaaS6Ts1ZXt_EbtWyfk-RtIZ-shF311rQOzSoAOk5HdS_Y6m6dlj1KbYO89bdTc_usbRJag8bBCW6DbYyHuGMTgrnRTQ7GOMG_DAlCn2_kY_lDfeY3lY7PpUYkokh37QhTZDOP93BH7OMpW0bDRPU2Ox9GPQfZOlm_KBTjPJVB1wBUmLhg'

Example response

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

{
  "id" : "59633756-e969-41bf-8f44-769b78dccb0f",
  "name" : "Test Custom Role 49",
  "createdBy" : "c9360a7a-7868-4e05-b328-aa9d3aeb6ab4",
  "createdAt" : "2023-11-29T13:33:39.825858Z",
  "updatedAt" : "2023-11-29T13:33:39.825858Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
  "_title" : "Test Custom Role 49"
}

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

The human friendly name of this {@link CustomRole}.

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link CustomRole} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link CustomRole} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link CustomRole} was deleted. This will be null for an {@link CustomRole} that has not been deleted. If this property is not null, then the {@link CustomRole} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJ1TmlNQW5ReXdyRzZvVlYyam9TZ05BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUyYThhNDBiLWE4MTgtNDEzOS04NGM3LTE2Y2EyY2IxNWU2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjM4OTdmZGEtMzExNi00MGY5LWIwYzAtMmI0YjY1OWI1OGJlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.NdxcLx-YZp0FyaXD44htu4dfDNxCGaNwwtB9ElTT_Dct_hVF4URPLUMRHwUWFH1HBvOm8NZefujImQVeJJe_9UKYFxjV8cH5hQ4TClPdYYCSQ7eZ6rZ6t5TxRa0k8LQRbPm5rIpraVTbzb6_pLuq6oCR5v49Yq8u5Rl-s0AdM4VPT5RLNpIP7txEDR8geRci5uCQOsAzRsbkq5aq5d_aPfvGwkx3HiS_9s-siTA1aQaJlGSYXsoRuFVqjQQrw2_Ecm7Xm0cnWfHa5plyhM0Ci2OjSB9bAmZwZbVR1gvW43pm1jDQXCi9IUGFbGFR3L6OFRfjZ7kRWwPVoXvlGVKiwg' \
    -d '{"name":"Test Custom Role Create"}'

Example response

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

{
  "id" : "72dcec24-7496-4282-9beb-c5aa0f3b24c9",
  "name" : "Test Custom Role Create",
  "createdBy" : "52a8a40b-a818-4139-84c7-16ca2cb15e6c",
  "createdAt" : "2023-11-29T13:33:40.107916Z",
  "updatedAt" : "2023-11-29T13:33:40.107916Z",
  "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/56144b45-1a45-45c5-b860-38995e41f3f4' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiIwMDNqOVU0d3M3Wk01Qm1xdUpObFZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNjNTEzNzU1LTAwNzItNDAwZS05NDU2LTQ0OWVlOTU3NWYxOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDE4OTM5ZTAtYTQzMi00YzVlLWI5YTktNGVhZTdhYzUyMGE4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PFC0Nxz6Da8tqvz3xkv2Hi9VFXRR8CoFQHUUZoklcn2SM954PgbdXl-eFWblcMYLb6yWOXuTkuqf-u82AuFRmqg53qfB69UnGSg7UpvyYo_mU_y3bgCwuYIOvQdgBh7YaxCqzj8YnF54-BLg3SGode9if_MDWxN4SVoc9rRoU6gINZuinsAwCgIujpYdQui6QQCwFE_v2dahVHqn3ntCueZ6dQwYnLnejnATWOxd33bL306hNdgcARWvBlkrbQt0zwCzZGqAoVzInmDbiQfVL0Xvr07Aj7DNCQ96J0DoZxBHQohHGuNihmeGUNKlgyt50QVbvx9CIK24glyCzJEcGQ'

Example response

HTTP/1.1 200 OK

Grant Custom Role (deprecated)

POST /custom-roles/{id}/identity-grants/{identityId}

Deprecated.

Deprecated. Use {@link CustomRoleGrantController#createCustomRoleGrant} to grant an identity a standard role.

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/ee8a7549-eb96-45ee-9415-aa62d47ec3ff/identity-grants/aa8b2be3-2976-4b70-b360-58336c8477dd' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJiR3k0aVZqVWQ1RHZGdmViOWZCR1FBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM5Y2YzNDk0LTk2YTAtNDhlOS1iMzBiLTFkZDc3MGYwYmZhOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjYyOTVjNTMtOTQwZS00ZjdmLThmNTctNjRiYWE5MmZlN2UzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfSx7XCJpZFwiOlwiZjNmMWE1NTgtMzdmNi00NGQ0LThmNTQtZTM2NzcxYWU4Njc2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.KLW9dCzQNcqr2yv26EgHyPnm_EM9TlGYu15RCBKoTBcmKm29lqZUmiF1wKP-TRz2hvL47PNmr5oOVVaJSqBsv0TBbuL5q6iNmGgg8XI3Sp1KVh9qN6pdK-VgPNuGV7REjLJMMHxAXZ7so2oMsGgrHo_MdwF2jlklXMaRxkVMPCEqmXc-xvxbEkoZQeOoUvhq7PGUPfMDw26M4KprQRkiPlI0dlvwu60qc_gWFzMJRoCQHWoA2KBjiydYdkrDOLQ9gWBuSJiuionbIgyR990jNsUAiZbHgylPRYDQnRrVLhr1QqaS4QrJnYhhaEU6Qh4o_4vqS1sE2R2cIRpJOTDHKQ'

Example response

HTTP/1.1 200 OK

Revoke Custom Role (deprecated)

DELETE /custom-roles/{id}/identity-grants/{identityId}

Deprecated.

Deprecated. Use {@link CustomRoleGrantController#createCustomRoleGrant} to grant an identity a standard role.

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/2bca3e6d-7dd6-481f-8c3b-6cfa5b74f65d/identity-grants/2fc65c66-fb74-452b-a67e-d0059e39b52a' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJyeXJPMmsyU241c1JzQ2NuNFZ1NUVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMxOGU5NDA5LTg3OWUtNDJlZi1hOGJjLWM5M2RkN2I5YWIwNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjBhZjU4MGItNGQ0Yy00NmJlLTg3ZjMtYzM5MGZjMTc1ZTc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfSx7XCJpZFwiOlwiYmFmYmMxOWItZjRiZC00YjBkLTk1NzAtZGNmMTkyN2I1OWQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.qU9NzW7cq61v2TJCEjUfcAwEv_yV1-7BU7GEp_tcDvOjD3zd0KjjmFxzDcviF5rYyADJy1ri8AF4XpS4H2vebKclqdAh6TeGBu-yW-Uk6j-v0ThQe59vZ4BL5cE-hubCL8lkHqBGdsj7qek0f1FbJKDUDiOk3uedWOrB6aa4jp7BJTvIuk0Oq1NIN9pwKdqoB_KKNvcoYIrmgmw8jyCF7hymJcTGYciaGK5GwM95bN68dfFrh0Xve5rLS4ROEFUO2-lnF6Lby5WE00Xf1gmiVu7GhuUDjViq9xhW-_9IPNiYADH7vlqMHP8cx8gku94Jrd8cTFzZgZcYVPBt2FX9bw'

Example response

HTTP/1.1 200 OK

Custom Role Actions

Find Custom Role Actions

GET /custom-role-actions

Returns a set of {@link CustomRoleAction}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

{@link ResourceAction}s. For example, if the path is to Network X which is under Network Group Y, this would restrict the results to {@link CustomRoleAction}s that grant an action on any resource under Network X, an action on Network X itself, or an action on Network Group Y. Combine this query parameter with resourceActionIds to limit the results to the types of actions along the path that are of interest.
The path value must start with a domain code followed by a colon. It may then have a comma delimited sequence of colon separated resource type code and resource id pairs. The path structure must match that of the server defined resource tree for the specified resources in the specified domain. only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to those from one of the specified ,{@link CustomRole},s.

resourceActionId

Object

true

Filters results to those that grant one of the specified ,{@link ResourceAction},s.

path

Object

true

Filters results to those that target any resource along the specified path.,
, For example, if the path is to Network X which is under Network Group Y, this would restrict the results to ,{@link CustomRoleAction},s that grant an action on any resource under Network X, an action on Network X itself, or an action on Network Group Y. Combine this query parameter with resourceActionIds to limit the results to the types of actions along the path that are of interest.,
, The path value must start with a domain code followed by a colon. It may then have a comma delimited sequence of colon separated resource type code and resource id pairs. The path structure must match that of the server defined resource tree for the specified resources in the specified domain.

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].customRoleId

String

true

The {@link CustomRole} that this {@link CustomRoleAction} belongs to. This {@link CustomRoleAction} should be granted to any identity that is granted this linked {@link CustomRole}.

Must not be null.

[].resourceActionId

String

true

The {@link ResourceAction} that this {@link CustomRoleAction} confers to the identities that hold the linked {@link CustomRole}.

Must not be null.

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link CustomRoleAction} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link CustomRoleAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link CustomRoleAction} was deleted. This will be null for an {@link CustomRoleAction} that has not been deleted. If this property is not null, then the {@link CustomRoleAction} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[].path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link CustomRoleAction} targets. For example, if this {@link CustomRoleAction} is "Update Widget Service" then this property defines the (id) path of/to the "Widget Service" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to the {@link ResourceAction#getResourceTypeId()}. Both must target the same {@link ResourceType}.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJrWlJudUZDWHNlNmlobzNyZ3o1ZWV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM0YzRlOTk5LTg1ZmUtNDFkZS1iYTJlLTYzM2U4ZjkxYWUzMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOCwiZXhwIjoxNzAxMjY4NDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWNhMjQwMmMtZDNlYy00OTkzLTgyMDAtZDllMjE4ZjhmMGI0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.m1SJoLvk0kJahNtGDfxOYR33lXqPsB132I308ymWGrhjElGRXQi5f4hFnJ30k7H2-dRo9zA_pMtL5r8thtJF1sGVN47L5oXMwPKIysh65ZaOIps9kC60Y5Y6MO_xGO-I3Kql8DXO0kVcsJ9fLY3Cq4jH_SxmMv8f5rE2XXv4LrkkxxcvjfcbdmNYomUWJ3qdR7N9teyQLxrwxdwcGRtVwEsVEyzrNpI3kkL5g-jKLFTUjh2iXb3qJkNWWobfNadsUGFGyaYjarUqBnZOSxBfBAq6j6nM3N2EpqY7hOj5vs-bLhj_LW8eRd6UorlJMByNOa4GAbkb2rdTJEoqPTNgKQ'

Example response

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

[ {
  "id" : "1a3c4da7-9950-42b2-9053-463b90f05f0b",
  "customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
  "resourceActionId" : "aa2fad0a-8146-4c62-99d7-555837f50d19",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:27.128216Z",
  "updatedAt" : "2023-11-29T13:33:27.128216Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Update Transfer Node, All"
}, {
  "id" : "370bfcbf-0a8b-4f7e-8ebb-59a921ea5ba0",
  "customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
  "resourceActionId" : "795b6aef-a482-4abb-9377-d07add8dc89c",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:27.125672Z",
  "updatedAt" : "2023-11-29T13:33:27.125672Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Read NetFlow Export, All"
}, {
  "id" : "efd8798c-5eac-4dde-a6f7-1bd3be991020",
  "customRoleId" : "74a9a6c3-106c-40bc-acab-780c837ad8d0",
  "resourceActionId" : "8c0eeb84-e029-4baa-9815-23c101cc8f75",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.845821Z",
  "updatedAt" : "2023-11-29T13:33:23.845821Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ ],
  "_title" : "Read Healing Alert, 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

The {@link CustomRole} that this {@link CustomRoleAction} belongs to. This {@link CustomRoleAction} should be granted to any identity that is granted this linked {@link CustomRole}.

Must not be null.

resourceActionId

String

true

The {@link ResourceAction} that this {@link CustomRoleAction} confers to the identities that hold the linked {@link CustomRole}.

Must not be null.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link CustomRoleAction} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link CustomRoleAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link CustomRoleAction} was deleted. This will be null for an {@link CustomRoleAction} that has not been deleted. If this property is not null, then the {@link CustomRoleAction} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link CustomRoleAction} targets. For example, if this {@link CustomRoleAction} is "Update Widget Service" then this property defines the (id) path of/to the "Widget Service" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to the {@link ResourceAction#getResourceTypeId()}. Both must target the same {@link ResourceType}.

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/afd61144-0459-4de4-817b-a4f9af18c16f' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJueHczeXQ2YkFBM3FYUzJIbnRxN2lnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU0YTU5YjM0LWFiNGMtNDgzNS1iNjEyLTAxNWI2ZDAzZGJlMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOCwiZXhwIjoxNzAxMjY4NDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTU3YTA5M2UtZWQxZi00YWZkLThlODctMzgwMDljMmRjNmM3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PdhN_T2P5ZZZynHBuhWW3plevSpstiCo1HVrlSO_X1OfvkfXSYDUjLbVtT4S2i5zoQ3hjY53kqTF2xMh4kPf67q-f7yqpsopsOMeuPpmdwkFT4dSKBb6uLAwPLs8IXkjjz_ptqcG8FVOtpS4slpfi-iivn9DyR8sCZwosZ4Vb5MuwOIe6tlue72nQkhxhucPijqLKXMzuLAXnAYa7KybcnT6bzXOLWr9kSxmr04KKc9GBvpb_R4JWjyDe8kNYFc8E8AIeBg5UpUnJei09Hi2p9A7QjmIdPwnfoA57ONoryCzosC4ttLcLLIA7WtRUAC9vAjNp5iLcwNR4k2-Zi3SPw'

Example response

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

{
  "id" : "afd61144-0459-4de4-817b-a4f9af18c16f",
  "customRoleId" : "25371414-8888-43f2-bd4f-f1da8420d108",
  "resourceActionId" : "824b8beb-ff7f-41ec-9afc-baeef9f1f2e2",
  "createdBy" : "c280c247-5346-4333-88be-f99e2c5130df",
  "createdAt" : "2023-11-29T13:33:38.282Z",
  "updatedAt" : "2023-11-29T13:33:38.282Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "e41f38f0-a647-4c6b-a736-047172b1e1dc",
    "resourceTypeId" : "c52e470b-7c06-445a-99bb-dee392c7f264"
  } ],
  "_title" : "Test Action 35 Test Type 34 on/under Test Type 34 e41f38f0-a647-4c6b-a736-047172b1e1dc"
}

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

The {@link CustomRole} that this {@link CustomRoleAction} belongs to. This {@link CustomRoleAction} should be granted to any identity that is granted this linked {@link CustomRole}.

Must not be null.

resourceActionId

String

true

The {@link ResourceAction} that this {@link CustomRoleAction} confers to the identities that hold the linked {@link CustomRole}.

Must not be null.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link CustomRoleAction} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link CustomRoleAction} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link CustomRoleAction} was deleted. This will be null for an {@link CustomRoleAction} that has not been deleted. If this property is not null, then the {@link CustomRoleAction} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link CustomRoleAction} targets. For example, if this {@link CustomRoleAction} is "Update Widget Service" then this property defines the (id) path of/to the "Widget Service" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to the {@link ResourceAction#getResourceTypeId()}. Both must target the same {@link ResourceType}.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJEbFdrbnZMZjFBa1NzMDRacVA4MkRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk4MGI1OWRhLTM2NWQtNGE1NC1iYmZmLWE2MjdiMGVlODdkZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOCwiZXhwIjoxNzAxMjY4NDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOGU4YWQyY2EtZjdjZS00Y2ViLTkyM2ItNDg3NGJkYTBhMTZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fSx7XCJpZFwiOlwiODJmMWE3NmMtYzRkYi00ZmY3LWFmZmItM2FiNzViZGJhZGQyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fSx7XCJpZFwiOlwiMmQ4MmNiNWItZjM0MS00ZmRhLTg2MWMtZjgwMjMyNzMyMmVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EM1XKt_VpNZs_WsR2LmKCMDCftnyXuvGtE6-baGij-ERyBKp8dHu_Afl7zSK9DftHkPc3PbaFfpvHZchG_dqfO5qOcRupEYM6fkR88HXGBb4wQMF743NVfNy9C6HuOMkU70LzvSGY4VwJYZVbW4ERLNlXDCtA6cwn17P9zzzwnEwQ-XnlLmh3RcFtGsN8cu3kX6oIXvRzkNm5oVrciKeryKX2inJvuhpEUl4RYSP2ewwX6E2Q4GNO0j5Z-VKYXOoOAjdpmgUVA_qBGIwOI6_R85u1OKQ7fK3nfYWqJ1dDQBidWYOPBsJh1FOM8ADLD3A7DqAoNQLkwycO6WNJVJo2Q' \
    -d '{"customRoleId":"cf3d3fd9-3caa-43ef-88e3-c3e79279ec8e","resourceActionId":"ba5b4716-dfa9-4709-8995-f3b1d29efc7c","path":[{"resourceId":"ff78c7c3-1713-4727-83c0-19ab56e1bead","resourceTypeId":"36d9ef9c-c535-4978-aa98-5730cc5e1460"}]}'

Example response

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

{
  "id" : "86ebfc58-2524-4669-a0bf-06349afdfa45",
  "customRoleId" : "cf3d3fd9-3caa-43ef-88e3-c3e79279ec8e",
  "resourceActionId" : "ba5b4716-dfa9-4709-8995-f3b1d29efc7c",
  "createdBy" : "980b59da-365d-4a54-bbff-a627b0ee87de",
  "createdAt" : "2023-11-29T13:33:38.159344Z",
  "updatedAt" : "2023-11-29T13:33:38.159344Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "ff78c7c3-1713-4727-83c0-19ab56e1bead",
    "resourceTypeId" : "36d9ef9c-c535-4978-aa98-5730cc5e1460"
  } ],
  "_title" : "Test Action Test Type on/under Test Type ff78c7c3-1713-4727-83c0-19ab56e1bead"
}

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/a3311b97-e143-46da-9b07-29c23fd796fd' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJpQUVUYXRJYnowQUFNZW1pTmlYRTJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRiYWUyYTAxLWU1NTctNDQzZi1hOTRkLTUzMmJlMWJhOTgwYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOCwiZXhwIjoxNzAxMjY4NDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZGM1MDA5NWYtZjI5My00ZTVhLWE4NmEtZDE5ODA4ZTNlNTBkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ohrTmLHrbsFSZRmAJdfVkJqEhAW_qbt8k4jxAoUM8YIN3tLe_lWtVxNMTQ8cN0IcY5XuKIY0rEo66ZTL1xDkwW5R68wQp9Oj1Mv3R9-TiMFEO3tvHpHB7yjbIFCkPEjU_uIsUX7p3TH29TVxZFI-FpjGWibNWvsS9yWVLNGXgfMKF5kT35xeEZQ8ll8YHF4iN3U4f0zlTD-JdR3yaoim0mFYyRDBdc9T3a6zmCTJSVuojUuBXDxfcFpaXW_eAtgp9uNcrTL6drbuZ9dxUSU_ALiKgDn9XPjNKiWMT1iFYC-2Z10MGUsB9E0Ro0-LbOdjfdzleJBzyZG7HDSsQLdAOA'

Example response

HTTP/1.1 200 OK

Custom Roles Grants

Find Custom Role Grants

GET /custom-role-grants

Returns a set of {@link CustomRoleGrant}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to grants to one of the specified ,{@link CustomRole},s.

customRoleIds

Object

true

Deprecated..

identityId

Object

true

Filters results to those granted to one of the specified identity ids.

identityIds

Object

true

Deprecated..

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link CustomRoleGrant} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link CustomRoleGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link CustomRoleGrant} was deleted. This will be null for an {@link CustomRoleGrant} that has not been deleted. If this property is not null, then the {@link CustomRoleGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-grants' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJEYk9DUm45UEhjVUdWZzFwbFBpMExBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdmNDNjMzY1LTViYWMtNDJkMS1hNjQwLTUwM2UwMmM2MGM0MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOCwiZXhwIjoxNzAxMjY4NDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODAwNjhkMmQtNDBkMy00ZmQ2LWI1OWUtODNiYWNhZTA5NzEzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.P9BIh082I8d0gYn0SELTUPYiJUgJ2Pa35EKXIR4GXkRIyhkQUXRXJL08ej5Jko-WhRqIk0n2XuNc38YWkRXF3o6EUojpJzkphW9EAtUlojTCa1HBv7nF9Xf-k6RK6Nqra3TwD3xPAlzYX6U51Z6cY85aY9Yo-jx1IIqpmiZ5zlr7CrGWR4eEGYLkirZEfDKSwnS0IcVD9JsIfdiXe2zRIeuc2W_Qx-ZscYBrx4avhSWtStjmSa1VaAaSnTRNchdfYbYi0SZTniSIM5YExzZR0MLHc100JBZc53EYcH13PNxaIq1vGygTynehRYt2Hz4nQuF8TWgUF5_sAX1_ArCtfw'

Example response

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

[ {
  "id" : "cfe59e05-0da2-489c-9549-c73b2b0f9c9d",
  "identityId" : "48ef8928-4f59-4428-b4df-83cd7ec770bf",
  "customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:26.325074Z",
  "updatedAt" : "2023-11-29T13:33:26.325074Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 48ef8928-4f59-4428-b4df-83cd7ec770bf"
}, {
  "id" : "51342275-4bab-4058-b736-02602a2b8800",
  "identityId" : "3bab810d-0f7c-4214-98e6-5299c8fc64dd",
  "customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.500515Z",
  "updatedAt" : "2023-11-29T13:33:23.500515Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 3bab810d-0f7c-4214-98e6-5299c8fc64dd"
}, {
  "id" : "9c685e3d-1f90-4aa0-a859-7460c8fc1685",
  "identityId" : "8c86e52a-f2b1-426b-aca8-86dec4ebed48",
  "customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:27.284328Z",
  "updatedAt" : "2023-11-29T13:33:27.284328Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 8c86e52a-f2b1-426b-aca8-86dec4ebed48"
} ]

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

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link CustomRoleGrant} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link CustomRoleGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link CustomRoleGrant} was deleted. This will be null for an {@link CustomRoleGrant} that has not been deleted. If this property is not null, then the {@link CustomRoleGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-grants/a557f339-463b-4844-a895-eed1d7d8b553' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJCSjJxUk9fV1gzZ0o1aVZPTlFNaDhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg1MThjNTA4LTg0YWQtNDZmMS1iNTlhLTNmYzBjYjg1NzU5NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOCwiZXhwIjoxNzAxMjY4NDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWRlZmE1NDQtMTYwNS00NWU0LWJlZjAtODNkYzg4ZDM5NDBjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.aw-daOzJYMbpQ2Wpvt2dZInYzIy48jwAyuYcJq6hSoZIp13pNqnfbAMLZYH_iZi0l8ocx1dw1Ebwsd40TW6QbAqy1DJQuUVdXWXXHo7Rrr5Snkh7xsCwJn0YUI1QtYICAN7n39wrYaPma8lGdOOVCmotdEW52Rh6eyjYAu3pC7ErURik0oF_1SiEr7eGWNZA0QGiusRxhyoCNyFuns8bcGVe6ptHSzcrWzs7OcSM42F2HcgjQRG-sKC3D739ZZPJpWArXB0li0cqnlxSUTPb3u3Bii1qxesMLQ_gdRpg7-7Ifeug3YG0CUuJvZPTeasFqDYPwF2IMvBIwftRWWkOHQ'

Example response

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

{
  "id" : "a557f339-463b-4844-a895-eed1d7d8b553",
  "identityId" : "9dc9202a-895f-4c0f-bdf2-8985a6e30857",
  "customRoleId" : "1d26553c-8b1b-47c3-a46d-5858e27e152e",
  "createdBy" : "8baa7d1b-9725-4222-a636-2daf42bec452",
  "createdAt" : "2023-11-29T13:33:38.622789Z",
  "updatedAt" : "2023-11-29T13:33:38.622789Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Custom Role 40 to identity 9dc9202a-895f-4c0f-bdf2-8985a6e30857"
}

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

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link CustomRoleGrant} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link CustomRoleGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link CustomRoleGrant} was deleted. This will be null for an {@link CustomRoleGrant} that has not been deleted. If this property is not null, then the {@link CustomRoleGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJTc2M4dlFBVlM1aHlpbDBibDBTbF9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIxNWMyNDJkLTQxMDUtNGZhMS1iNmExLWZjZTM2MzliOTAwMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOCwiZXhwIjoxNzAxMjY4NDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNmQxM2MxMjQtNTRkMC00MDJmLTljMWEtZjFlNTBhZWMwYTY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fSx7XCJpZFwiOlwiYWU0ZWZjZjMtOGM5ZC00NjUzLWI1YWQtNjU1ZTQzMTEzZDVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.lUmJuIAqj-N6lWgGtRVjla5pZsbc3vF1vqLDq9KxUXhE9CjK8o9L4cPtsHIyGlZdMHsPpd5mZU08uRyAxezgrSeQDFz-NdDnLM9N7AvLp3MVYDSVRZBCGPWyUs_tTQC283p8QPWYlWO1-yyE_870ggstaD7TEu78MxHbPMXG6afXcXALMVNjVPBzH6CrLvdMYcWXIhuiWxgdJCPqyjzHRSdtma4LsEtLzJKlFLzWzc76pefBF_MEbBp4BUaYhKYrorktXoN_Iy3jmNkhqoJ1P8j0RYD3U6wKYtxwq39CPk5UCFvKQTKkf6dluG3UmzTQ-x8Do0lnA2I19N2SWWfBMA' \
    -d '{"customRoleId":"1a19e562-a042-48af-8419-f39f45a9ce8e","identityId":"387a5cd8-7ad7-4e5d-bb24-a6b99a360170"}'

Example response

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

{
  "id" : "01ddefdb-9f23-492f-a8e7-449563d2dde4",
  "identityId" : "387a5cd8-7ad7-4e5d-bb24-a6b99a360170",
  "customRoleId" : "1a19e562-a042-48af-8419-f39f45a9ce8e",
  "createdBy" : "215c242d-4105-4fa1-b6a1-fce3639b9001",
  "createdAt" : "2023-11-29T13:33:38.838046Z",
  "updatedAt" : "2023-11-29T13:33:38.838046Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Custom Role 42 to identity 387a5cd8-7ad7-4e5d-bb24-a6b99a360170"
}

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/f5798406-ba55-4f24-9488-78d265b23bc1' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJ4TFpsT2czME9jbHZsc1RUQlFGUWVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUzYzRiMDk4LTA2YWYtNDgwZi1iZjk1LTYwYjNkM2RkMWI4MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxOCwiZXhwIjoxNzAxMjY4NDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYzBjNzAyNjEtNGY4MC00MGZkLWE1NzgtMzk4MzBmZWQ2MjEyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.JttVKl2ale68SCKaHQTpeghawpsSYPKh4iXT64G0LmtHV6OtgndW8gtxL43Ztk3urQgy2r6EZJfL7GfTADez_aspbOlGhyfZnRZw5l_gfmzf92oWyDV57T8xLsmIF7O-UhkMKPfzQkb_EhQQJX_5VI3SczGdFbA8Wd1wkVNXBury7H2HL7k6IBspN6Pynshw-zLN5YDebxZdnhpMMvth4n80EyhNlqc0IIkJvp-2fYLd-GrOPSvQUPbKEjxf0uPNlOHC87zzWn9SpHDyQBZ8PJNmsjeXG9jaWVGWVmt8AqvU32aszKJfdHvG6aVHt_uFQRqhPSrrgJfBI3-Od77gRQ'

Example response

HTTP/1.1 200 OK

Standard Roles

Find Standard Roles

GET /standard-roles

Returns a set of {@link StandardRole}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

{@link StandardRoleType}s. identities. resources.
For example, if Network id X is passed, this would restrict the results to instances of a Network X Standard Role, such as Network Admin of Network X, Network Read-Only of Network X, etc. This would exclude Network Group Standard Roles, even if the Network Group contains Network X. For example, if the path is to Network X which is under Network Group Y, this would restrict the results to {@link CustomRoleAction}s that grant an action on any resource under Network X, an action on Network X itself, or an action on Network Group Y. Combine this query parameter with resourceActionIds to limit the results to the types of actions along the path that are of interest.
The path value must start with a domain code followed by a colon. It may then have a comma delimited sequence of colon separated resource type code and resource id pairs. The path structure must match that of the server defined resource tree for the specified resources in the specified domain. only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to those that are of one of the specified ,{@link StandardRoleType},s.

identityId

Object

true

Filters results to those which have been granted to one of the specified identities.

resourceId

Object

true

Filters results to those that specifically target one of the specified resources.,
, For example, if Network id X is passed, this would restrict the results to instances of a Network X Standard Role, such as Network Admin of Network X, Network Read-Only of Network X, etc. This would exclude Network Group Standard Roles, even if the Network Group contains Network X.

path

Object

true

Filters results to those that target any resource along the specified path.,
, For example, if the path is to Network X which is under Network Group Y, this would restrict the results to ,{@link CustomRoleAction},s that grant an action on any resource under Network X, an action on Network X itself, or an action on Network Group Y. Combine this query parameter with resourceActionIds to limit the results to the types of actions along the path that are of interest.,
, The path value must start with a domain code followed by a colon. It may then have a comma delimited sequence of colon separated resource type code and resource id pairs. The path structure must match that of the server defined resource tree for the specified resources in the specified domain.

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

Request fields

No request body.

Response fields

Path Type Optional Description

[].id

String

true

Must not be null.

[].standardRoleTypeId

String

true

The 'type' of this {@link StandardRole}.

Must not be null.

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link StandardRole} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link StandardRole} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link StandardRole} was deleted. This will be null for an {@link StandardRole} that has not been deleted. If this property is not null, then the {@link StandardRole} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[].path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link StandardRole} targets. For example, if this {@link StandardRole} is "ACME Corporation Account Manager" then this property defines the (id) path of/to the "ACME Corporation" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to this {@link StandardRole#standardRoleType}'s resource type. Both must target the same {@link ResourceType}.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiI2S1VBb3lXLXdqclNmMGg5eUJycTh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ5NDkyODRhLWM4NjktNGJkZS05YjU4LWY4NGQzNDlmMzczNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNywiZXhwIjoxNzAxMjY4NDE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDAwMGJjM2QtZDRkMi00Mzg2LWE2OWUtYzgyZjM1NDZkNmY2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.NKlmRWtc0GgLa5aNz_-0SxUyJlqfnY_Vmrnwzw4PiWQIz8tr7OaaifUX86EtGVEQWt46lAXABVpa7Dfyib6kqimWtn_LM2ysX8Fi-WKVqHzpF6S6OpL85fRYV5K2EVG1940mdzt6QIRyU68dhWJ24VrPtzDsxpBPg42JbIzG5dW7P4GbyORGSBz8xoUqBDQGTx46r_e_gorqWeldu3Ji6P3k7TCzx0PhfipEoIQ-19132w20_ddQOsrOfYbUunLb_LdVis_oV9P9JWb-86kp5n8lhe4tgtTI2RgXJbp6IWnMgMUz062yb0FtTyKh9k_wj8k0GPJ6c3eXaMWZyLa6ww'

Example response

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

[ {
  "id" : "58fcc2eb-081c-4214-b293-3d8fce80e119",
  "standardRoleTypeId" : "3b74ce60-2997-4cac-a818-8df34fd13403",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:27.174935Z",
  "updatedAt" : "2023-11-29T13:33:27.174935Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "faefbc90-edbc-45fc-a699-a91bb5dd47af",
    "resourceTypeId" : "6d04c969-badf-4d3a-ad0b-8e5958c66783"
  }, {
    "resourceId" : "19a208da-672c-4a3b-8cb4-848a9b0d612e",
    "resourceTypeId" : "92158fb6-3845-4aa9-a7a0-c75500089723"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Standard Role Admin - 19a208da-672c-4a3b-8cb4-848a9b0d612e"
}, {
  "id" : "d6f99f78-7546-4f2a-98a7-5699bdb71d0a",
  "standardRoleTypeId" : "792731c8-2d2d-4859-9437-055a26b2a7e7",
  "createdBy" : "9916c0fe-1286-4c1d-9387-6235a2d502a5",
  "createdAt" : "2023-11-29T13:33:37.330291Z",
  "updatedAt" : "2023-11-29T13:33:37.330291Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "3665e112-9ec3-4542-843f-989ca19e09df",
    "resourceTypeId" : "2cf17ac3-002d-4945-8a55-4a8d74ac4901"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 22 Admin - 3665e112-9ec3-4542-843f-989ca19e09df"
}, {
  "id" : "9a234e10-839a-4a6b-b6d6-d501885de9de",
  "standardRoleTypeId" : "5ed9fc87-2724-4f9f-889f-c737dc5ced10",
  "createdBy" : "86fbe08d-373c-4c2d-80bc-3fa957b7b123",
  "createdAt" : "2023-11-29T13:33:37.685916Z",
  "updatedAt" : "2023-11-29T13:33:37.685916Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "8d10e04c-b98d-4292-8e11-45e71dcc1bb7",
    "resourceTypeId" : "e364289a-9bf0-4929-9f6b-fbab6861a1ef"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 26 Admin - 8d10e04c-b98d-4292-8e11-45e71dcc1bb7"
} ]

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

The 'type' of this {@link StandardRole}.

Must not be null.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link StandardRole} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link StandardRole} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link StandardRole} was deleted. This will be null for an {@link StandardRole} that has not been deleted. If this property is not null, then the {@link StandardRole} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link StandardRole} targets. For example, if this {@link StandardRole} is "ACME Corporation Account Manager" then this property defines the (id) path of/to the "ACME Corporation" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to this {@link StandardRole#standardRoleType}'s resource type. Both must target the same {@link ResourceType}.

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/e75f6eca-b94e-43a4-afc5-86834ceefee5' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJTa1N6RDNIeFFfaFQ3bktFeHdyemFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU1Yzc2NzgwLTkxNDAtNDJiNy04YjE0LTBmZjUwZWQ0NTFiZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNywiZXhwIjoxNzAxMjY4NDE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDY5MjM5NzQtNjY4MC00ZjczLWI3NTQtYzUzMmI0MjNhNTJhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ix71r849NZ5yQlsnuBM46EqwgyfUreMCqTXln8co2lYncSnyPO96cr5wwK2BnVzGqAJfJFrQIkWGr2sEQsINUs2IFcsRZTGQL9LkaPuMgg2o3y4EquQOcOhlxCIEkvwVHuR3of0xgQ2NaxvuVPVWLPKrCZiUl76JE8Iz-ckK9H1UyWMi2P9BZvwA4JQVLk5-nJ0MJCzE9hTMUzUWKbkuqwENqVGAAAIYAZVX3IXBi-k9_D0HiG7srQJqq8vxHo8_vM73hmv_llgnK7a9tJH5qFmo8atzP542Oqp0NX0nk9F9Y1UjYTGrQOR8XqWZA6BOw8xkyDfUmYUi91WjNetgKg'

Example response

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

{
  "id" : "e75f6eca-b94e-43a4-afc5-86834ceefee5",
  "standardRoleTypeId" : "7d2bf7ba-a2cd-477b-ab23-1a9485b2d1f5",
  "createdBy" : "9b9903b8-c874-4ab2-a6d9-a5ca975c7d6a",
  "createdAt" : "2023-11-29T13:33:37.478978Z",
  "updatedAt" : "2023-11-29T13:33:37.478978Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "fbbf2b93-de3b-4c39-9c8e-08332f1c4e82",
    "resourceTypeId" : "e836da84-8173-49ad-a5ea-659ab4c7d0cf"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 24 Admin - fbbf2b93-de3b-4c39-9c8e-08332f1c4e82"
}

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

The 'type' of this {@link StandardRole}.

Must not be null.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link StandardRole} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link StandardRole} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link StandardRole} was deleted. This will be null for an {@link StandardRole} that has not been deleted. If this property is not null, then the {@link StandardRole} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

path

Array[Object]

true

The path (ordered pairs of resource type and id) from resource tree root to the target resource that this {@link StandardRole} targets. For example, if this {@link StandardRole} is "ACME Corporation Account Manager" then this property defines the (id) path of/to the "ACME Corporation" resource. The path, specifically the ordered list of resource types that it contains, is co-variant to this {@link StandardRole#standardRoleType}'s resource type. Both must target the same {@link ResourceType}.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiI3N0dQVE1qZjFMSVMwQk9VTkktdTN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg2ZmJlMDhkLTM3M2MtNGMyZC04MGJjLTNmYTk1N2I3YjEyMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNywiZXhwIjoxNzAxMjY4NDE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjQwODA2ZWEtOTQ1Ny00ZTA2LWJjMGEtZDNkMmViNDJkZDczXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE3fSx7XCJpZFwiOlwiMzY0M2NiNmQtZDc1MC00ODMyLTljNzUtMmM5YTkyOTgwMDRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.cpGHwTGJs54ZVkyefA3kkjyfpmeYzswqBLZZL4_nnFK5WU6iAREcB04oNTsNR6NCTyjXKVVBwIwnE4JKMRYc2nUZIGBiQbr0oyZXtVy4JGUaFpJhLaSzI4BtIIIdHOQQOmXovORmIA3m8UcCj9AUsrqagch4OZwor-lkzRhWr-6bPVxO0RXFRsUgfr_mKuEMEg8RlrbbemAgYIbOUxOgrxGlsiKCZo8hHCnDZHNiNEAwxbLKfNkWQ0YOmJgyAVcIoNdjxrX5_R8Qs6qaQx06F5QlFwlYKFgtcu3FTPPpCyZRsL6rbGf-HY5Hb08UT9ntOMJoSjshXpLITmJNA5oPiA' \
    -d '{"standardRoleTypeId":"5ed9fc87-2724-4f9f-889f-c737dc5ced10","path":[{"resourceId":"8d10e04c-b98d-4292-8e11-45e71dcc1bb7","resourceTypeId":"e364289a-9bf0-4929-9f6b-fbab6861a1ef"}]}'

Example response

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

{
  "id" : "9a234e10-839a-4a6b-b6d6-d501885de9de",
  "standardRoleTypeId" : "5ed9fc87-2724-4f9f-889f-c737dc5ced10",
  "createdBy" : "86fbe08d-373c-4c2d-80bc-3fa957b7b123",
  "createdAt" : "2023-11-29T13:33:37.685916Z",
  "updatedAt" : "2023-11-29T13:33:37.685916Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "path" : [ {
    "resourceId" : "8d10e04c-b98d-4292-8e11-45e71dcc1bb7",
    "resourceTypeId" : "e364289a-9bf0-4929-9f6b-fbab6861a1ef"
  } ],
  "type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
  "_title" : "Test Type 26 Admin - 8d10e04c-b98d-4292-8e11-45e71dcc1bb7"
}

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/66c9fd14-5a18-410f-827d-01d42aab5b0f' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJGcEk0VHp4WGxnUjM3V1lpUjZsMWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUxMGRlZWQ1LTdmOGYtNGUwNi1hN2VmLWJmODUyNDgwNWU3ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNywiZXhwIjoxNzAxMjY4NDE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWIzNjY0ZDgtNWRhNC00MjRkLWI0MzYtMGU5MGE1MDMzODhiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jsozgtv8puQS-IL2OFwuvgok3xsajjKTlbGpedxZHgIslQOVFfc_4ixOP-04ffGOGJF_6XTiWNTmxdzyyaD83a3peA-oVlS3U5gkhNdF99LYpWtPSAmH7qSCHdUr4hFd3IQpIwwrN_DmuAKDlyV7IaFuiSnEx-MAGjAmgiw4LAY9l7XaPLhnfTi4GZj4HJDW3UR1Uq7HJeO8iJP2Py3Q2t6WGMT4J1JPEy47N86iklU0Fdc6a3zOWZCEB7vv1yTGlNuBUlXGdtlhTmo7XQOe9hVaPqn4rDSgi6dSOyoRBQIqrUUmboH9iNr6Ji1pIK-ni62TsKgk4ANGDnmJtdcMXw'

Example response

HTTP/1.1 200 OK

Standard Roles Grants

Find Standard Role Grants

GET /standard-role-grants

Returns a set of {@link StandardRoleGrant}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to grants to one of the specified ,{@link StandardRole},s.

standardRoleIds

Object

true

Deprecated..

identityId

Object

true

Filters results to those granted to one of the specified identity ids.

identityIds

Object

true

Deprecated..

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link StandardRoleGrant} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link StandardRoleGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link StandardRoleGrant} was deleted. This will be null for an {@link StandardRoleGrant} that has not been deleted. If this property is not null, then the {@link StandardRoleGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-grants' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJJdEs0emFGSXRoeDg2bzhSbGliV2xRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg4YTg4YTQwLWNiZGItNDg5YS1iNzZlLTg5ZmY3MTU4MDNkNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNiwiZXhwIjoxNzAxMjY4NDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjFlNWZhMmUtOTM3Zi00OTMxLTliMGEtNTBkMDdjZDk2MzYzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.kr1JmGfUFrZxMAPeGp0iTXrjjC3lMIKKo6sZKNnAum6ItNMnKhCJWd7q1rUJTSgiOZ5QM3R3HYYtB0FT5MfBHtV3lWoeh2Dw3r-rqN1drJM-pQB1gWAgQ5KaqU0I35nI0DqLx6Pw7v1vr1lum4Slf-6aw4vzX_XzF48urWWLLELO576nqH7ptfKEo4r8E-FRXf2RnrR6uZV8muWEriIyHW5QxUZR85DDSeKuViif1X--IxZ8xXZvUaK8Q6DuxiTUQzjzeHknYTQHXLu2W7lgMLtkKwxXzEBAJFbgYCVCh1O5nBzd5tb6ycCByh0kA4Xjmc8LsmrR9TLxaTQ5CI3HOA'

Example response

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

[ {
  "id" : "73e07111-e25b-4975-bca8-e67d6cdd0abb",
  "identityId" : "f3981e14-9744-44f1-8acc-0882c87a860d",
  "standardRoleId" : "4b80c858-9b36-4d06-ad73-3c9fd302982e",
  "createdBy" : "a7d13829-f649-4e0a-be82-0a879843e28d",
  "createdAt" : "2023-11-29T13:33:36.832660Z",
  "updatedAt" : "2023-11-29T13:33:36.832660Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 16 Admin - 073d6586-a063-4a44-a77e-c576fdfcc936 to identity f3981e14-9744-44f1-8acc-0882c87a860d"
} ]

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

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link StandardRoleGrant} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link StandardRoleGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link StandardRoleGrant} was deleted. This will be null for an {@link StandardRoleGrant} that has not been deleted. If this property is not null, then the {@link StandardRoleGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-grants/d1835b66-7b39-4519-a7c8-0d363b62a9e6' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJxdnhCaEM1aDRWMmJIUS1LQWZHTGRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA0NDgxNGMzLWQ3NWQtNDJiZi1iMjRhLTIyZjVhMTU2ZTIxOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNywiZXhwIjoxNzAxMjY4NDE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjc1YjljNmYtZDRkMC00OWU0LWE1ZTItZGI0M2E5NWFjNTc0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.EuBAVACSNDOBZt4Of2l_g-GnM-XbkFDpBY5kHlB6AnuXXn6O829XTn75L1RQSFoXmuAOZNAHxP6uPtHh2-gaoLWfiPYE7nInv04RpFuRsBf1laGX4HTZIM1S2cIgCQfV2aE8ieWB2t0P6BDSdnDPRDYgCNinP_NZmKXGVm7hdMO8gL5N0JsKHSseQ1tyFaJpa4gBZPe2AeFp8OTJQrljg9nn02P1wq0TwKzwh1t8biJ8hL0fVpHuMs05u_Svov_BnRK_OmMO2D-UNVzXfd40PqXhDN1ljRzK92bLApk7_pCY8colIkcsHTtOgstanmOBiH1ZeKb7ZhPD4vCOeLYXgw'

Example response

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

{
  "id" : "d1835b66-7b39-4519-a7c8-0d363b62a9e6",
  "identityId" : "c7f6e9e2-897a-4819-b357-d389c85bf9ed",
  "standardRoleId" : "e9da38ee-affd-4626-8378-69de528c8ebd",
  "createdBy" : "ee64b70a-8c90-47ad-8b30-e443e609cde0",
  "createdAt" : "2023-11-29T13:33:37.058782Z",
  "updatedAt" : "2023-11-29T13:33:37.058782Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 18 Admin - 09efd56b-cdc6-45fc-978e-2734e9e78a12 to identity c7f6e9e2-897a-4819-b357-d389c85bf9ed"
}

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

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link StandardRoleGrant} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link StandardRoleGrant} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link StandardRoleGrant} was deleted. This will be null for an {@link StandardRoleGrant} that has not been deleted. If this property is not null, then the {@link StandardRoleGrant} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

_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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJDQmtGOU5kSVJNOUdfNW1uZ3d0dWJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE3ZDEzODI5LWY2NDktNGUwYS1iZTgyLTBhODc5ODQzZTI4ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNiwiZXhwIjoxNzAxMjY4NDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTExZjhiZDgtZjZjMi00ZmE4LTliNWEtMGU3MjRhOTdmMWU2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fSx7XCJpZFwiOlwiOTdlMjIzMzUtYzQ1NS00ZDM3LWFhMmYtZWE0NDdlZTNiM2Y5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.NzLKMPmdAH7WL4B9FHaXSURWAGQnYY0VPFRAPII2WvZFGLmBg4XQ5Aa2Sbk1shKp_5TGysEOuwshi60jcFNw2v8m_osqIBJzqPONXVEjzoJVvJO1f4SOZ5T32-Mt73m5zCkVvOa96zRtImYPIwBTWXVrydzDOZ8wOkWHicKSV99xRHc4KUJVpJjcysrAZsD2xvaodU5PdMVY3KYZxI7-SXVjS91e6IspsYfG1lxFUEkymyz79sI0SO0_CcnquJncLCDzeG4VnDoLw8xIi7yfe9HMV1lkEr9nUfohrkeQv8_XYLgVp679nE0D4_YFv9-DvNcF22O2IJPH5Yz8v6Ub0A' \
    -d '{"standardRoleId":"4b80c858-9b36-4d06-ad73-3c9fd302982e","identityId":"f3981e14-9744-44f1-8acc-0882c87a860d"}'

Example response

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

{
  "id" : "73e07111-e25b-4975-bca8-e67d6cdd0abb",
  "identityId" : "f3981e14-9744-44f1-8acc-0882c87a860d",
  "standardRoleId" : "4b80c858-9b36-4d06-ad73-3c9fd302982e",
  "createdBy" : "a7d13829-f649-4e0a-be82-0a879843e28d",
  "createdAt" : "2023-11-29T13:33:36.832660Z",
  "updatedAt" : "2023-11-29T13:33:36.832660Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Grant Test Type 16 Admin - 073d6586-a063-4a44-a77e-c576fdfcc936 to identity f3981e14-9744-44f1-8acc-0882c87a860d"
}

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/aa778256-63e0-487c-b3f0-2a4958ed82f3' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJUOVhuSVc2WmZ2QVg0clUzelFoeW1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjMGIxZDhiLWY2M2UtNGU0Mi1hZjEzLWFiMDE3MzE0NGRhNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNywiZXhwIjoxNzAxMjY4NDE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTBiODZiZDctZmU4Mi00OGM2LWFkOWEtOGExYzE4YWRmNjc4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.MFpCHMdP-9xPAKG-acrOb6mo0IcKRyLdFUHTrLsgKEqJzzzkuYObwxIbDLAFi9ld63G29M7wpYJz49W7QCl5QmaiFHeg8sAnNOk7CQIqTj0AlSXTOdIC3rVtmEGPt0b5OfjszW4EudCBc95oz8pBy1PdgyTcczR4TMBYpawkmRjXjgLQHyEv5O5Hee7tYiXXwH3DiIImfYaQuFhtKdMG0MwYjdJw4linWyyArYUheA0F3JPxxNhrg32F8zWhL37HdK5Cn3v3CGAvcDaTtYf3LSTP9fGBl7ITrncrY6PmB_cThuqqIvVXb1Z136lk9vHC2fkUDonGgbQDqj9HcmVFLg'

Example response

HTTP/1.1 200 OK

Standard Role Types

Find Standard Role Types

GET /standard-role-types

Returns a set of {@link StandardRoleType}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

{@link ResourceType}s. strategies. by the specified {@link StandardRoleType}. In other words, all returned {@link StandardRoleType}s are logical sub-sets of the {@link StandardRoleType} specified by this query parameter.

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

Filters results to those that target one of the specified ,{@link ResourceType},s.

resourceTypeIds

Object

true

Deprecated..

authorizationStrategyName

Object

true

Filters results to those that are of one of the specified strategies.

authorizationStrategyNames

Object

true

Deprecated..

includedByStandardRoleTypeId

Object

true

Filters results to those whose actions are fully included by the specified ,{@link StandardRoleType},. In other words, all returned ,{@link StandardRoleType},s are logical sub-sets of the ,{@link StandardRoleType}, specified by this query parameter.

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

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link StandardRoleType} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link StandardRoleType} was updated. The only supported 'update' on this bean is to mark it as deleted.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJUbndGc3UyWmstR3FfU3B3aWFINTZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZiMzM2NmMzLWU4NDgtNGNlZi1iZGM0LWM2ZjRiN2E2NTI3MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTAwM2JiOGMtZjBhNS00MjQ1LTg2NTUtODM4NTczNmQxOTkyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PVNTmpowVTfl9DwzaulsPIKg3-ty-eXplUKAm_-BksJquRwxtAFAKC0jPL4UNOY1X0IlL_bPY0M-lG5bS-F4Wy_FB6Upc-R3oRancC5YdMiWeOqvuxyx1ci7tJz2xn8-wDm6agY3BQTML9YePI42kFur270bDJKemTcCmHKn6DXBPKwNVyzmxnU8ZxW8frALqNMsFjMlnh3Cpa4kVs7GMDXeH-Qp3zhqmw-gbx0Cjn_VD9ZClUTdIrnbIwEvc2i7b_FmtpDyYkSWoFamp-TqLY8ggt3MnGzj1Youms9R73qaqqnR4KHxu8rJdegdY6EtOakLxlwbm_TH5bRK88pNAA'

Example response

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

[ {
  "id" : "769cbb3d-4956-48aa-ac24-cef1857e4239",
  "resourceTypeId" : "936ef057-c6bb-4208-a84e-a0890cb3adea",
  "authorizationStrategyName" : "Admin",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.420728Z",
  "updatedAt" : "2023-11-29T13:33:23.420728Z",
  "_title" : "Custom Role Admin"
}, {
  "id" : "83fe0b0c-d840-45b4-abc4-754a49400bc9",
  "resourceTypeId" : "36d2fb4d-b075-480e-9cb5-40f6da282d07",
  "authorizationStrategyName" : "Read-Only",
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:22.770554Z",
  "updatedAt" : "2023-11-29T13:33:22.770554Z",
  "_title" : "Organization Read-Only"
}, {
  "id" : "792731c8-2d2d-4859-9437-055a26b2a7e7",
  "resourceTypeId" : "2cf17ac3-002d-4945-8a55-4a8d74ac4901",
  "authorizationStrategyName" : "Admin",
  "createdBy" : "c078eb68-cb02-493a-b7b9-da75c50aa788",
  "createdAt" : "2023-11-29T13:33:37.323755Z",
  "updatedAt" : "2023-11-29T13:33:37.323755Z",
  "_title" : "Test Type 22 Admin"
} ]

Get Standard Role Type

GET /standard-role-types/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

resourceTypeId

String

true

Must not be null.

authorizationStrategyName

String

true

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

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link StandardRoleType} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link StandardRoleType} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types/f833fb0b-c599-40b0-935b-0d22deecb3eb' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJDc0dmWm83UHI1eGxXSENnS3N6MEtBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEyNzQ4ZTdmLWNiMDUtNDA0Mi04NDNhLWU4MTRkYjBlMzZhNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2U0ZGI5MDMtNDlmZi00NjI5LTk2ODYtMDA3ODQ5ZmM4NDQzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.RroP_KkMzWcf5Wd2ARTM0zk5VQ37fA22s0zXQjwaM-bR4tAdIZnNIOCiFXpjhkA1R2_cGmp5NokSLN4bhjUGIN0ap7GQFOYlWZYM5L5lHPOiybKdu6KEEAVyDSozqN4q2pxf4NWTRRbKOGMXO9VFUk4Mah4GWOo5vaTgOM6SlbpiKUSV6P7d93Njbg8PB7m9iUvOAwZEL3ydP62b6L7I_ocEL2AU5k_vApsJ-s2Fw5hNcJloYZoGm0CvMdIxax4Lp71Tq5ICd_p1-HoxCBdLFnl2wrvkXMkl0l_wlgJTBjDO4nHJ11Bduo3FSRE5fAAU5sJoDz5T8wP4Uj725Lf-kw'

Example response

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

{
  "id" : "f833fb0b-c599-40b0-935b-0d22deecb3eb",
  "resourceTypeId" : "3cdd2a43-2a91-4bbd-bc3a-4e60527fa721",
  "authorizationStrategyName" : "Admin",
  "createdBy" : "79edac55-2beb-43a7-9483-4eee460cd976",
  "createdAt" : "2023-11-29T13:33:40.415135Z",
  "updatedAt" : "2023-11-29T13:33:40.415135Z",
  "_title" : "Test Type 54 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

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link StandardRoleType} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link StandardRoleType} was updated. The only supported 'update' on this bean is to mark it as deleted.

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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJKM21vUEcxYmtMTGFwRXJqOHI3U01RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM1NDBlMjQ4LTAyZGItNGI3Zi04Y2VkLWI2NDFjNTRmZGMwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgyMCwiZXhwIjoxNzAxMjY4NDIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcIjU0OWJiODc4LWE4ZDMtNDRjMC1iYTRjLTExYzA4MjVkNTZiNVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcImNjZGQxMDgwLTJiMzgtNGIyMS04YTIyLTJlYWQ5NzNlYTQwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxOX0se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWFmMTJmZjktNmE1My00N2VjLWFiY2ItZDJhYjdhNmYzMTkyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfSx7XCJpZFwiOlwiMzViMDY0ZjYtMzk1Zi00NGU1LWI1NjQtNDUyMWI1YWRhMWFlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODIwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.aSmc1WacTXIxTEyaj0e8lwqBEQqnYfYXYEG38LOPtCEAvjKL6jHEVtylKEZHj_8BK0Rg2Ikz9e8wKkOajCrwwpTamXW-aNKPrd8x88c_G9iZIsFVP7x_FUkyY6n42IV09LH8aJIn3o420hE_glvh1sYcDiPmp7BisFeCRh0AHXTEXHAju0w86OBcgGfHi2YZ_Bpx9zxOM5F3eGwsMaSwpFJ960v4TfZmOsFTDMUZTBQ9smJ1Yu0N1MqAkqYD2KQkLwf6BkLncEi7KAMvejYEFX65Q5LE7xt8j9_STZHzCcacxFGealaBxIiq_-06MWiXDUx7kVny-VufwtLRqcZQYA' \
    -d '{"resourceTypeId":"36d9ef9c-c535-4978-aa98-5730cc5e1460","authorizationStrategy":"Admin"}'

Example response

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

{
  "id" : "1fcf5bd1-42f2-4d1a-898b-2ef099c8ce67",
  "resourceTypeId" : "36d9ef9c-c535-4978-aa98-5730cc5e1460",
  "authorizationStrategyName" : "Admin",
  "createdBy" : "c540e248-02db-4b7f-8ced-b641c54fdc0d",
  "createdAt" : "2023-11-29T13:33:40.360044Z",
  "updatedAt" : "2023-11-29T13:33:40.360044Z",
  "_title" : "Test Type Admin"
}

Resource Action Inclusions in Standard Roles

Find Action Inclusions

GET /action-inclusions

Returns a set of {@link ActionInclusion}s that the client is authorized to read and which match the specified (optional) query parameters.

If multiple query parameters are specified, then results must match each query parameter that is set. If a query parameter supports multiple values, then a result must match at least one of the values. In other words, distinct query parameters are AND’d while value matching within a single query parameter act as an OR condition. For example a query parameter "?x=1,2&y=3" becomes (X == 1 OR X == 2) AND (Y == 3).

strategies. {@link ResourceAction}s. only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

Filters results to those that apply to one of the specified ,{@link ResourceAction},s.

authorizationStrategyName

Object

true

Filters results to those that apply to one of the specified strategies.

isDeleted

Boolean

true

When true, returns only those that are marked as deleted. When false, returns only those that are not marked deleted. When not set, returns all those that are otherwise matching, whether they are marked deleted or not.

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

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is above the {@link StandardRoleType}'s {@link ResourceType}.

[].includeWhenAt

Boolean

true

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is the same as the {@link StandardRoleType}'s {@link ResourceType}.

[].includeWhenBelow

Boolean

true

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is below the {@link StandardRoleType}'s {@link ResourceType}.

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link ActionInclusion} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link ActionInclusion} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link ActionInclusion} was deleted. This will be null for an {@link ActionInclusion} that has not been deleted. If this property is not null, then the {@link ActionInclusion} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[]._title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJ2NEFpRENEVkZzNkNHcktYdEtFdG9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQxNjA0NjRmLTdhM2QtNDZiNC04NDdlLTlhMjM1MTg0Y2UxYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNSwiZXhwIjoxNzAxMjY4NDE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTFjNjAxNjEtODA2Ni00YzZiLWI2M2ItNjlmYWEzYjk4YzZkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.YK2j64yNN6RL9C5TbxhJ99mlrFTd8jSGBfEZbrZPywlPY0BHP5WNjoH0yOIFuUMP_kgWbqWEtfpMHi-sxcpjmvZYVUAuPUR5BWfiWhA-kAzOigUQt2HEWxRRkW9SBJ2v3-lv6lppgIdGtebCcyu1eVFHa_WMZOeUEzfN7lBgemUU-pm89JRKuzexqzlXqzhriJCsI0p4IbgItN34qy6vkHznlTZWQSKzaAhPV-BVy4r2LrhURtCShpwUjQnWWGsA9df_BMR3qP_1i9d1TDg-v8BAEODi6hUQrSkGtEZjN-U-W6iUFwUli35-MUm0NfrTGUY4SZhC5GkSmE5oETP03g'

Example response

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

[ {
  "id" : "ad9843aa-98e9-41b0-be01-e949fec612c4",
  "resourceActionId" : "ae04cfd6-d842-438f-beeb-44ef836632b0",
  "authorizationStrategyName" : "Admin",
  "includeWhenAbove" : true,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:26.167347Z",
  "updatedAt" : "2023-11-29T13:33:26.167347Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Read Identity Preference in Admin Standard Roles"
}, {
  "id" : "87010e1a-0b0a-4445-bb15-c628f492eb94",
  "resourceActionId" : "fd9c0077-d54a-449a-8785-ea1f505af337",
  "authorizationStrategyName" : "Contributor",
  "includeWhenAbove" : true,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:23.782472Z",
  "updatedAt" : "2023-11-29T13:33:23.782472Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Read Domain in Contributor Standard Roles"
}, {
  "id" : "dc947c65-de03-4cdd-bd7d-f485d51979ca",
  "resourceActionId" : "b43ec5e7-f5b5-4f65-a527-53161cb553c4",
  "authorizationStrategyName" : "Admin",
  "includeWhenAbove" : true,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
  "createdAt" : "2023-11-29T13:33:24.516470Z",
  "updatedAt" : "2023-11-29T13:33:24.516470Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Read Edge Router in Admin Standard Roles"
} ]

Get Action Inclusion

GET /action-inclusions/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

true

Must not be null.

resourceActionId

String

true

Must not be null.

authorizationStrategyName

String

true

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

includeWhenAbove

Boolean

true

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is above the {@link StandardRoleType}'s {@link ResourceType}.

includeWhenAt

Boolean

true

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is the same as the {@link StandardRoleType}'s {@link ResourceType}.

includeWhenBelow

Boolean

true

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is below the {@link StandardRoleType}'s {@link ResourceType}.

createdBy

String

true

The identity id that created this resource.

Must not be null.

createdAt

String

true

The date-time at which this {@link ActionInclusion} was created.

Must not be null.

updatedAt

String

true

The date-time at which this {@link ActionInclusion} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

deletedAt

String

true

The date-time at which this {@link ActionInclusion} was deleted. This will be null for an {@link ActionInclusion} that has not been deleted. If this property is not null, then the {@link ActionInclusion} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

_title

String

true

Example request

$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions/ea7623ec-3c82-48c1-82d1-0a5b80f81dc8' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJjdWQxOGtRQy02U3hoeHNFeFFqSnNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlmNzM2YjdkLTEyZWYtNGMzYi1hNzMzLTQ3ODk4OTMwNWFlNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNSwiZXhwIjoxNzAxMjY4NDE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOWFmMzE2MDEtNGExYy00NzhlLTg1ZDEtOTU2ZGNhNmM1MzZiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.DwKFjx-8AqbVM4fzmnViQufhAjenpnU7hcY0PnNnc38GoRNaYLWCqvsBZ4wTA9ufRsoNhdEDF6sAgOSQNTpkoYBeEXSyMv7lPlCBsKo2TS4SHX18H478GB8jjSz0FFVmh53bbKqVTOl6s_rbSqS00Gq6XQYg_VmFJtsLN1OvPXaEKnE-ua4w1Gr8TGQP69VyaNvFYbHDTYYBy7YRbTT_CSbGJpEUH_gfAo46tmTBO72bQois9L1xcX8XxVu4X21gUKA2Vup7vUh2huaPpFjdZG4q_WhEyzeP8lObkei4Xzm97CMDfxNbVGuqO_WmVRn_F2wY4l9QEd6goibXiYig2Q'

Example response

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

{
  "id" : "ea7623ec-3c82-48c1-82d1-0a5b80f81dc8",
  "resourceActionId" : "0e37ea7e-ceed-4f2b-ad81-f7c79e62082c",
  "authorizationStrategyName" : "Admin",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "a1c8effa-ef8d-42b2-9047-e9acd79bbd7a",
  "createdAt" : "2023-11-29T13:33:35.851886Z",
  "updatedAt" : "2023-11-29T13:33:35.851886Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Test Action 8 Test Type 7 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

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is above the {@link StandardRoleType}'s {@link ResourceType}.

[].includeWhenAt

Boolean

true

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is the same as the {@link StandardRoleType}'s {@link ResourceType}.

[].includeWhenBelow

Boolean

true

True if the linked {@link ResourceAction} should be included in {@link StandardRole}s where this {@link ResourceAction}'s {@link ResourceType} is below the {@link StandardRoleType}'s {@link ResourceType}.

[].createdBy

String

true

The identity id that created this resource.

Must not be null.

[].createdAt

String

true

The date-time at which this {@link ActionInclusion} was created.

Must not be null.

[].updatedAt

String

true

The date-time at which this {@link ActionInclusion} was updated. The only supported 'update' on this bean is to mark it as deleted.

Must not be null.

[].deletedAt

String

true

The date-time at which this {@link ActionInclusion} was deleted. This will be null for an {@link ActionInclusion} that has not been deleted. If this property is not null, then the {@link ActionInclusion} is 'marked' as being deleted. For data retention reasons, we never actually delete a resource.

[].deletedBy

String

true

The identity id that deleted this resource. This will be null until the resource is marked deleted.

[]._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 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJTbm1oOGdrN3NNNUxyeVNmazlfUHhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk4OTg5NGEzLTE5MTgtNDA2Mi04NWU1LTUwMTc4MGM3OTYxNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNiwiZXhwIjoxNzAxMjY4NDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjVhODZmMjAtZDE5Ny00MzBkLTliNjEtNGNkNWUwMjM3NGM4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fSx7XCJpZFwiOlwiNjM2M2NmNDQtNzk5Ny00NzRjLWFiNWYtM2VlZmFmYzljMDU2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.nO46JTos8HmhOIULM3f0N4JmQp3hXB5RMIJgNMROnDd4na19ZxNQoOWre7FTMZ0roC9heRZFKqVxvKkJ93Fb2qL9DMmzx7ru7WnitiTQadkMwprOKKQ5XCbHd4kruv0F4zmVqWZvKME8wCIIJHZVf_PGgFhYgAd6NsJvy0B17nsSGxdeL3mBerIxo7gbVoOjfFieqjEabZlyOMLHI-LNSiKIDoKucYL6hEp4M4N7arigCafkWOwW1kbCNiun7ia_ChIAvOw_fKte922LX772W_s_hrnZL3_ms8Qim64AuY4TfHjp8JgEq1AYzBb9pOBdsAUlqseKTxmE5KC6UugVTA' \
    -d '{"resourceActionId":"889a72c1-0ca5-4578-a188-07bf9aad0110","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'

Example response

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

[ {
  "id" : "3d0f5c6b-eead-45a1-a917-4badf6e3c58f",
  "resourceActionId" : "889a72c1-0ca5-4578-a188-07bf9aad0110",
  "authorizationStrategyName" : "Admin",
  "includeWhenAbove" : false,
  "includeWhenAt" : true,
  "includeWhenBelow" : true,
  "createdBy" : "989894a3-1918-4062-85e5-501780c79614",
  "createdAt" : "2023-11-29T13:33:36.184289Z",
  "updatedAt" : "2023-11-29T13:33:36.184289Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_title" : "Inclusion Rules for Test Action 14 Test Type 13 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/e47e0070-0560-4f8a-b432-ec379a013a75' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjQ3MTgxOWJhLThjNzMtNDc1Mi1hMGU3LTM1OTk4MDViMzcwOCJ9.eyJqdGkiOiJTSXIxWVlRUjlBMmE0WVZrUjVFSzJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFhNTVkZjZiLWEzZjMtNDBjNC04NGNkLWY2NTRkNmIyMGQ3OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTcwMTI2NDgxNiwiZXhwIjoxNzAxMjY4NDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjExYTEzNDA2LWVkMjUtNDY1ZC05ZDhmLWZkZjNlOWZmYzI4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMzI1ODcyLTU1M2YtNDQzNy04MzgwLWQ0ZGU2NmQ3YTk4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNn0se1wiaWRcIjpcImY2NTgxY2MzLTYyMjUtNGFhMC1hOWQ4LTAwYTNlYmExNTNmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjRkMzVkNjNkLTE3MWEtNDJlNS1iM2M3LTRlMGNhMjBhNTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgxMX0se1wiaWRcIjpcIjk2NmYyZDQ1LWI3YzItNDQ5Zi05YWM2LTY4MTdkNjc4YjE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjhkYTUyOTZhLTBhODItNDQ1NC1iYmZkLWJhODU5NWI2ZGNhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImIwMjM5MWIxLWIyMWQtNDk1MS05NTgzLTJmN2Q3NzI3MzJiMVwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwNH0se1wiaWRcIjpcIjA4NGZkYWUwLWQyZDktNDZkOS04MTNlLTcxYzhhNTlkMTQ0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcImNhZjNmNmE3LWUyOWYtNGQwNy04MGM5LTJmNTllNjlkOWI0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM30se1wiaWRcIjpcIjg5NTZjYjI2LWJmZGItNGRlYi04Y2ZhLWFiYjZhNzgyZWI0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTcwMTI2NDgwM31dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWE4ZmM5MGUtYjUwMC00YzBhLTgyOWQtNmZkM2I1YWU5ZTFmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzAxMjY0ODE2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.N5Tjfvv_Gu8pSOckvvCrM-IOHPjqM4Xri4Qiu_8TBTm8I3wRvQygEreRwICcaw7f7FmwQGal169w-32bgL0AZRYYGtRccyugsUS9cvsZFL5_bFQ8vsjm537SovpRc-l-YEaurdHz5gOguuw40bWesQ8ktLG57AvKYzfpq76WweUvlK4sBWtE5ARegxh5h8tHS9BsdG8pxBUK3OjDnezzI1Y0wbU1zN2CemVh05lbPEbw-HT4c2rmRaf7KSL-YuvO3sF9yGUtm2a3dPif0vMxZE0bS9hdew3fDeoQp6rbgkhXz8f_BoVFwcGSP22BCxrFElrPmrO0-PylgKfYkQyNqw'

Example response

HTTP/1.1 200 OK