Introduction
This is the NetFoundry identity service
Overview
HTTP verbs
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP verbs.
Verb | Usage |
---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource, full updates only |
|
Used to delete an existing resource |
The PATCH method is not used (yet).
|
HTTP status codes
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP status codes.
Status code | Usage |
---|---|
|
The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action. |
|
The request has been fulfilled and resulted in a new resource being created. |
|
The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services. |
|
The server successfully processed the request, but is not returning any content. |
|
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
|
The request lacks valid authentication credentials for the target resource. |
|
The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource. |
|
The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible. |
Resources
Organization
Find Organizations
GET /organizations
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
active |
Boolean |
true |
|
mfaProviders |
Object |
true |
Must be one of [None, GoogleAuthenticator]. |
includeDeleted |
Boolean |
true |
Default value: 'false'. |
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
name |
String |
true |
|
label |
String |
true |
|
identityProviders |
Array[Object] |
true |
|
identityProviders[].id |
String |
true |
|
identityProviders[].organizationId |
String |
true |
|
identityProviders[].auth0ConnectionId |
String |
true |
|
identityProviders[].name |
String |
true |
|
identityProviders[].auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
identityProviders[].active |
Boolean |
true |
|
identityProviders[].createdAt |
Object |
true |
|
identityProviders[].updatedAt |
Object |
true |
|
identityProviders[].deletedAt |
Object |
true |
|
defaultRoles |
Array[Object] |
true |
|
defaultRoles[].id |
String |
true |
|
defaultRoles[].organizationId |
String |
true |
|
defaultRoles[].name |
String |
true |
|
defaultRoles[].roleType |
String |
true |
Must be one of [Standard, Custom]. |
defaultRoles[].roleId |
String |
true |
|
defaultRoles[].createdBy |
String |
true |
|
defaultRoles[].createdAt |
Object |
true |
|
defaultRoles[].deletedAt |
Object |
true |
|
defaultRoles[].deletedBy |
String |
true |
|
defaultRoles[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
mfaProvider |
String |
true |
Must be one of [None, GoogleAuthenticator]. |
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations' -i -X GET
Example response
HTTP/1.1 200 OK
Link: <https://gateway.netFoundry.io/identity/v1/organizations?page=1>; rel="next", <https://gateway.netFoundry.io/identity/v1/organizations?page=1>; rel="last"
Content-Type: application/json
Content-Length: 2743
[ {
"id" : "113d978d-11e7-48c4-b5f2-1e68a27d0983",
"name" : "World Wide Imports",
"label" : "WW-Imports-71",
"identityProviders" : [ {
"id" : "c66f671f-00f2-429f-bc87-0fafddd01173",
"organizationId" : "113d978d-11e7-48c4-b5f2-1e68a27d0983",
"auth0ConnectionId" : "auth0-opaque-connectionId-72",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 205540000,
"epochSecond" : 1744903811
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "f4195024-18b6-4553-b34a-dcdcea2e16e8",
"organizationId" : "113d978d-11e7-48c4-b5f2-1e68a27d0983",
"name" : "Default Standard Role-80",
"roleType" : "Standard",
"roleId" : "3969a6c8-9e5f-47b0-b049-33870488295c",
"createdBy" : "5ae527cf-92c4-405e-83c6-c228eea91f5e",
"createdAt" : {
"nano" : 230579000,
"epochSecond" : 1744903811
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 199567000,
"epochSecond" : 1744903811
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "18c8b1cf-17f7-45e7-b510-381af95d6de6",
"name" : "World Wide Imports",
"label" : "WW-Imports-97",
"identityProviders" : [ {
"id" : "5aa9f1b8-7a93-48c3-8c37-1d5903754db2",
"organizationId" : "18c8b1cf-17f7-45e7-b510-381af95d6de6",
"auth0ConnectionId" : "auth0-opaque-connectionId-98",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 342706000,
"epochSecond" : 1744903812
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 339985000,
"epochSecond" : 1744903812
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "1d41f7d7-f2c7-4309-8687-8fe400852743",
"name" : "World Wide Imports",
"label" : "WW-Imports-192",
"identityProviders" : [ {
"id" : "8dee0cdd-b75c-4418-8fd9-337a86555aa6",
"organizationId" : "1d41f7d7-f2c7-4309-8687-8fe400852743",
"auth0ConnectionId" : "auth0-opaque-connectionId-193",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 442740000,
"epochSecond" : 1744903814
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 441050000,
"epochSecond" : 1744903814
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
} ]
Get Organization By Id
GET /organizations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
name |
String |
true |
|
label |
String |
true |
|
identityProviders |
Array[Object] |
true |
|
identityProviders[].id |
String |
true |
|
identityProviders[].organizationId |
String |
true |
|
identityProviders[].auth0ConnectionId |
String |
true |
|
identityProviders[].name |
String |
true |
|
identityProviders[].auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
identityProviders[].active |
Boolean |
true |
|
identityProviders[].createdAt |
Object |
true |
|
identityProviders[].updatedAt |
Object |
true |
|
identityProviders[].deletedAt |
Object |
true |
|
defaultRoles |
Array[Object] |
true |
|
defaultRoles[].id |
String |
true |
|
defaultRoles[].organizationId |
String |
true |
|
defaultRoles[].name |
String |
true |
|
defaultRoles[].roleType |
String |
true |
Must be one of [Standard, Custom]. |
defaultRoles[].roleId |
String |
true |
|
defaultRoles[].createdBy |
String |
true |
|
defaultRoles[].createdAt |
Object |
true |
|
defaultRoles[].deletedAt |
Object |
true |
|
defaultRoles[].deletedBy |
String |
true |
|
defaultRoles[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
mfaProvider |
String |
true |
Must be one of [None, GoogleAuthenticator]. |
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2071
{
"id" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 727751000,
"epochSecond" : 1744903767
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "e87c4976-eec1-409c-b88d-4f470460b1c6",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 609655000,
"epochSecond" : 1744903767
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "df8b8446-5c84-47ca-b6c1-ac87f1d5f35e",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "4dbb32b7-ec73-4fbf-aa38-138accc2f555",
"createdBy" : "544c2aaf-b6a0-4e3e-b9eb-d1a6f6a64e22",
"createdAt" : {
"nano" : 992530000,
"epochSecond" : 1744903767
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "bb43a59d-df21-4e1d-a216-202895ffd035",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "25803878-6066-465e-b841-a2c9281622f7",
"createdBy" : "f2688ce3-bc6b-4d11-8123-a638ac7cd939",
"createdAt" : {
"nano" : 966755000,
"epochSecond" : 1744903767
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 478939000,
"epochSecond" : 1744903767
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}
Get Organization By Label
GET /organizations/label/{label:[-a-zA-Z0-9]{1,63}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
label |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
name |
String |
true |
|
label |
String |
true |
|
identityProviders |
Array[Object] |
true |
|
identityProviders[].id |
String |
true |
|
identityProviders[].organizationId |
String |
true |
|
identityProviders[].auth0ConnectionId |
String |
true |
|
identityProviders[].name |
String |
true |
|
identityProviders[].auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
identityProviders[].active |
Boolean |
true |
|
identityProviders[].createdAt |
Object |
true |
|
identityProviders[].updatedAt |
Object |
true |
|
identityProviders[].deletedAt |
Object |
true |
|
defaultRoles |
Array[Object] |
true |
|
defaultRoles[].id |
String |
true |
|
defaultRoles[].organizationId |
String |
true |
|
defaultRoles[].name |
String |
true |
|
defaultRoles[].roleType |
String |
true |
Must be one of [Standard, Custom]. |
defaultRoles[].roleId |
String |
true |
|
defaultRoles[].createdBy |
String |
true |
|
defaultRoles[].createdAt |
Object |
true |
|
defaultRoles[].deletedAt |
Object |
true |
|
defaultRoles[].deletedBy |
String |
true |
|
defaultRoles[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
mfaProvider |
String |
true |
Must be one of [None, GoogleAuthenticator]. |
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/label/ACME-0' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2071
{
"id" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 727751000,
"epochSecond" : 1744903767
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "e87c4976-eec1-409c-b88d-4f470460b1c6",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 609655000,
"epochSecond" : 1744903767
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "df8b8446-5c84-47ca-b6c1-ac87f1d5f35e",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "4dbb32b7-ec73-4fbf-aa38-138accc2f555",
"createdBy" : "544c2aaf-b6a0-4e3e-b9eb-d1a6f6a64e22",
"createdAt" : {
"nano" : 992530000,
"epochSecond" : 1744903767
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "bb43a59d-df21-4e1d-a216-202895ffd035",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "25803878-6066-465e-b841-a2c9281622f7",
"createdBy" : "f2688ce3-bc6b-4d11-8123-a638ac7cd939",
"createdAt" : {
"nano" : 966755000,
"epochSecond" : 1744903767
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 478939000,
"epochSecond" : 1744903767
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}
Create Organization
POST /organizations
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
label |
String |
true |
|
auth0ConnectionId |
String |
true |
|
identityProviderName |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
name |
String |
true |
|
label |
String |
true |
|
identityProviders |
Array[Object] |
true |
|
identityProviders[].id |
String |
true |
|
identityProviders[].organizationId |
String |
true |
|
identityProviders[].auth0ConnectionId |
String |
true |
|
identityProviders[].name |
String |
true |
|
identityProviders[].auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
identityProviders[].active |
Boolean |
true |
|
identityProviders[].createdAt |
Object |
true |
|
identityProviders[].updatedAt |
Object |
true |
|
identityProviders[].deletedAt |
Object |
true |
|
defaultRoles |
Array[Object] |
true |
|
defaultRoles[].id |
String |
true |
|
defaultRoles[].organizationId |
String |
true |
|
defaultRoles[].name |
String |
true |
|
defaultRoles[].roleType |
String |
true |
Must be one of [Standard, Custom]. |
defaultRoles[].roleId |
String |
true |
|
defaultRoles[].createdBy |
String |
true |
|
defaultRoles[].createdAt |
Object |
true |
|
defaultRoles[].deletedAt |
Object |
true |
|
defaultRoles[].deletedBy |
String |
true |
|
defaultRoles[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
mfaProvider |
String |
true |
Must be one of [None, GoogleAuthenticator]. |
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"name" : "Best Corp.",
"label" : "BEST-CORP",
"auth0ConnectionId" : "auth0-opaque-connection",
"identityProviderName" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 736
{
"id" : "649c4036-f474-4e40-bbcb-622a650384e9",
"name" : "Best Corp.",
"label" : "BEST-CORP",
"identityProviders" : [ {
"id" : "ffd7973f-8c3f-4d8f-b9af-4615a10709a5",
"organizationId" : "649c4036-f474-4e40-bbcb-622a650384e9",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Best Corp.",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 204336000,
"epochSecond" : 1744903818
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 203154000,
"epochSecond" : 1744903818
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}
Activate Or Deactivate Organization
PUT /organizations/{id}/{action:activate|deactivate}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
name |
String |
true |
|
label |
String |
true |
|
identityProviders |
Array[Object] |
true |
|
identityProviders[].id |
String |
true |
|
identityProviders[].organizationId |
String |
true |
|
identityProviders[].auth0ConnectionId |
String |
true |
|
identityProviders[].name |
String |
true |
|
identityProviders[].auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
identityProviders[].active |
Boolean |
true |
|
identityProviders[].createdAt |
Object |
true |
|
identityProviders[].updatedAt |
Object |
true |
|
identityProviders[].deletedAt |
Object |
true |
|
defaultRoles |
Array[Object] |
true |
|
defaultRoles[].id |
String |
true |
|
defaultRoles[].organizationId |
String |
true |
|
defaultRoles[].name |
String |
true |
|
defaultRoles[].roleType |
String |
true |
Must be one of [Standard, Custom]. |
defaultRoles[].roleId |
String |
true |
|
defaultRoles[].createdBy |
String |
true |
|
defaultRoles[].createdAt |
Object |
true |
|
defaultRoles[].deletedAt |
Object |
true |
|
defaultRoles[].deletedBy |
String |
true |
|
defaultRoles[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
mfaProvider |
String |
true |
Must be one of [None, GoogleAuthenticator]. |
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/69f4ceaf-39f3-4353-8c06-3cceedbf0eb1/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 817
{
"id" : "69f4ceaf-39f3-4353-8c06-3cceedbf0eb1",
"name" : "World Wide Imports",
"label" : "WW-Imports-244",
"identityProviders" : [ {
"id" : "5c8d453c-822f-408d-b3af-b9600332eb3b",
"organizationId" : "69f4ceaf-39f3-4353-8c06-3cceedbf0eb1",
"auth0ConnectionId" : "auth0-opaque-connectionId-245",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 804721000,
"epochSecond" : 1744903818
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : false,
"mfaProvider" : null,
"createdAt" : {
"nano" : 803727000,
"epochSecond" : 1744903818
},
"updatedAt" : {
"nano" : 815743000,
"epochSecond" : 1744903818
},
"deletedAt" : null,
"deleted" : false
}
Add Identity Provider
POST /organizations/{id}/identity-providers
Authorization
This endpoint requires:
-
create-identity-provider
action on thisorganization
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
auth0ConnectionId |
String |
true |
|
identityProviderName |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
name |
String |
true |
|
label |
String |
true |
|
identityProviders |
Array[Object] |
true |
|
identityProviders[].id |
String |
true |
|
identityProviders[].organizationId |
String |
true |
|
identityProviders[].auth0ConnectionId |
String |
true |
|
identityProviders[].name |
String |
true |
|
identityProviders[].auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
identityProviders[].active |
Boolean |
true |
|
identityProviders[].createdAt |
Object |
true |
|
identityProviders[].updatedAt |
Object |
true |
|
identityProviders[].deletedAt |
Object |
true |
|
defaultRoles |
Array[Object] |
true |
|
defaultRoles[].id |
String |
true |
|
defaultRoles[].organizationId |
String |
true |
|
defaultRoles[].name |
String |
true |
|
defaultRoles[].roleType |
String |
true |
Must be one of [Standard, Custom]. |
defaultRoles[].roleId |
String |
true |
|
defaultRoles[].createdBy |
String |
true |
|
defaultRoles[].createdAt |
Object |
true |
|
defaultRoles[].deletedAt |
Object |
true |
|
defaultRoles[].deletedBy |
String |
true |
|
defaultRoles[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
mfaProvider |
String |
true |
Must be one of [None, GoogleAuthenticator]. |
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/fb7193eb-f338-4dd5-888a-98f451f3d3bf/identity-providers' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"auth0ConnectionId" : "auth0-opaque-connection",
"identityProviderName" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1156
{
"id" : "fb7193eb-f338-4dd5-888a-98f451f3d3bf",
"name" : "World Wide Imports",
"label" : "WW-Imports-240",
"identityProviders" : [ {
"id" : "c5c8c31b-cbc7-4966-b667-07843ff70573",
"organizationId" : "fb7193eb-f338-4dd5-888a-98f451f3d3bf",
"auth0ConnectionId" : "auth0-opaque-connectionId-241",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 650566000,
"epochSecond" : 1744903818
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "d821fa8c-922e-4578-a269-63ed1d22c6fa",
"organizationId" : "fb7193eb-f338-4dd5-888a-98f451f3d3bf",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 669286000,
"epochSecond" : 1744903818
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 648936000,
"epochSecond" : 1744903818
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}
OIDC Issuers
Find Oidc Issuers
GET /oidc-issuers
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1265
[ {
"id" : "3cb48c5d-4158-41de-9b15-3e9d4172e48a",
"issuer" : "https://cab3fed8-d230-4bfa-98f2-8833ea98014f.issuer.idp",
"jwksUri" : "https://cab3fed8-d230-4bfa-98f2-8833ea98014f.issuer.idp/jwks",
"active" : true,
"createdBy" : "7316ee83-928d-4f0e-b1f1-20b55b945943",
"createdAt" : {
"nano" : 670481000,
"epochSecond" : 1744903816
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "59eed01b-4021-499a-bbfe-0b1be6ffcb9b",
"issuer" : "https://f8cb0728-7bce-446a-ac3a-c2df0c3984d6.issuer.idp",
"jwksUri" : "https://f8cb0728-7bce-446a-ac3a-c2df0c3984d6.issuer.idp/jwks",
"active" : true,
"createdBy" : "809a53da-be42-4288-aae1-92ef917e3bfc",
"createdAt" : {
"nano" : 850135000,
"epochSecond" : 1744903816
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "695e2354-f164-45d6-bedf-18cb757e7bbd",
"issuer" : "https://c942e06f-e793-4318-9bd3-3f97d0b25746.issuer.idp",
"jwksUri" : "https://c942e06f-e793-4318-9bd3-3f97d0b25746.issuer.idp/jwks",
"active" : true,
"createdBy" : "ac66badd-b258-40e3-95af-ede61861329c",
"createdAt" : {
"nano" : 757808000,
"epochSecond" : 1744903816
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Oidc Issuer
GET /oidc-issuers/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers/527bfbdb-a461-4f14-bf59-30db416c366b' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 419
{
"id" : "527bfbdb-a461-4f14-bf59-30db416c366b",
"issuer" : "https://26602d2e-b7d1-4ea4-bb58-0a5c750f96b5.issuer.idp",
"jwksUri" : "https://26602d2e-b7d1-4ea4-bb58-0a5c750f96b5.issuer.idp/jwks",
"active" : true,
"createdBy" : "32b3d158-358e-4900-9e75-0089f379151e",
"createdAt" : {
"nano" : 364701000,
"epochSecond" : 1744903817
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Issuer
POST /oidc-issuers
Request fields
Path | Type | Optional | Description |
---|---|---|---|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"issuer" : "https://e69e46f3-2047-41a3-9175-3bf7e031b9bb.issuer.idp",
"jwksUri" : "https://e69e46f3-2047-41a3-9175-3bf7e031b9bb.issuer.idp/jwks",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 419
{
"id" : "03db19d4-6b01-4f0a-be17-c8c530292b90",
"issuer" : "https://e69e46f3-2047-41a3-9175-3bf7e031b9bb.issuer.idp",
"jwksUri" : "https://e69e46f3-2047-41a3-9175-3bf7e031b9bb.issuer.idp/jwks",
"active" : true,
"createdBy" : "0d693162-1cc5-4f30-b93a-04063a0bf7f2",
"createdAt" : {
"nano" : 325752000,
"epochSecond" : 1744903817
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Issuer
PATCH /oidc-issuers/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers/b89708be-d063-4131-99aa-4a2f0bcb6699' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"issuer" : "https://09ef35f2-6c5d-4e9c-88da-487e27399ff2.issuer.idp",
"jwksUri" : "https://09ef35f2-6c5d-4e9c-88da-487e27399ff2.issuer.idp/jwks",
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
{
"id" : "b89708be-d063-4131-99aa-4a2f0bcb6699",
"issuer" : "https://09ef35f2-6c5d-4e9c-88da-487e27399ff2.issuer.idp",
"jwksUri" : "https://09ef35f2-6c5d-4e9c-88da-487e27399ff2.issuer.idp/jwks",
"active" : false,
"createdBy" : "f2a8d7de-3674-4f26-8c38-d4ae77bcfdc4",
"createdAt" : {
"nano" : 242425000,
"epochSecond" : 1744903817
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Issuer
DELETE /oidc-issuers/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers/9c245b13-b0bb-41ca-8b24-3f82ea238717' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "9c245b13-b0bb-41ca-8b24-3f82ea238717",
"issuer" : "https://8531b430-4681-4ba7-aeca-94507a0c0e05.issuer.idp",
"jwksUri" : "https://8531b430-4681-4ba7-aeca-94507a0c0e05.issuer.idp/jwks",
"active" : true,
"createdBy" : "213a0d74-2311-4486-9920-a921a14623e6",
"createdAt" : {
"nano" : 414890000,
"epochSecond" : 1744903817
},
"deletedAt" : {
"nano" : 423851000,
"epochSecond" : 1744903817
},
"deletedBy" : "7b6558dc-c5c5-4c62-9ddb-7fc35c65c671",
"deleted" : true
}
OIDC Public Clients
Find Oidc Public Clients
GET /oidc-public-clients
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2068
[ {
"id" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"oidcIssuerId" : "fc221f2c-e97f-4994-a29e-afc26395f6b6",
"clientId" : "{clientId}",
"clientSecret" : "{clientSecret}",
"authorizationEndpoint" : "https://{auth0-tenant}.auth0.com/authorize",
"tokenEndpoint" : "https://{auth0-tenant}.auth0.com/oauth/token",
"userInfoEndpoint" : "https://{auth0-tenant}.auth0.com/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 80150000,
"epochSecond" : 1744903763
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "aed094d9-116c-4749-83b4-cd8a91db4b25",
"oidcIssuerId" : "5c8e149f-2161-4c76-a938-dffe13e0cbdf",
"clientId" : "clientId-94b447d4-869a-46d7-b27e-dc1ff32b9c1f",
"clientSecret" : "clientSecret-587befb1-d6de-4808-86c5-701444f8c1ab",
"authorizationEndpoint" : "https://1e0600f3-fc55-4106-8c5d-2919410eb117.issuer.idp/authorize",
"tokenEndpoint" : "https://1e0600f3-fc55-4106-8c5d-2919410eb117.issuer.idp/token",
"userInfoEndpoint" : "https://1e0600f3-fc55-4106-8c5d-2919410eb117.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "489cc29a-675d-431a-867e-0f758c4200bd",
"createdAt" : {
"nano" : 488968000,
"epochSecond" : 1744903817
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "f4e6fcd0-1839-4566-8828-856e42b8f156",
"oidcIssuerId" : "6c72dba0-a155-4804-9a70-89da12149793",
"clientId" : "{clientId}",
"clientSecret" : "{clientSecret}",
"authorizationEndpoint" : "https://accounts.google.com/o/oauth2/v2/auth",
"tokenEndpoint" : "https://oauth2.googleapis.com/token",
"userInfoEndpoint" : "https://openidconnect.googleapis.com/v1/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 80150000,
"epochSecond" : 1744903763
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Oidc Public Client
GET /oidc-public-clients/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients/bbad50ac-3710-4cc4-9b6f-3b058d99bb0e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776
{
"id" : "bbad50ac-3710-4cc4-9b6f-3b058d99bb0e",
"oidcIssuerId" : "e8e346c4-b011-42c2-95b5-caf84e3c5a10",
"clientId" : "clientId-5c9497bb-0003-4ee1-b6c9-2b229cc46540",
"clientSecret" : "clientSecret-d36d7ce1-f679-4733-a1ac-e87210821d91",
"authorizationEndpoint" : "https://39374177-fb7b-4dc5-bcc5-fc3e5ac34d5f.issuer.idp/authorize",
"tokenEndpoint" : "https://39374177-fb7b-4dc5-bcc5-fc3e5ac34d5f.issuer.idp/token",
"userInfoEndpoint" : "https://39374177-fb7b-4dc5-bcc5-fc3e5ac34d5f.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2fd00d15-7655-415d-9baa-716dfd5dbc3d",
"createdAt" : {
"nano" : 933874000,
"epochSecond" : 1744903817
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Public Client
POST /oidc-public-clients
Request fields
Path | Type | Optional | Description |
---|---|---|---|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"oidcIssuerId" : "2fdd1175-6a36-49a6-9933-a3606c659366",
"clientId" : "clientId-66c44c04-a79d-4fe4-ba10-90b376584bb4",
"clientSecret" : "clientSecret-ad3f8b9d-66fa-4e3c-a1fc-f47e872acd2f",
"authorizationEndpoint" : "https://c90b14ed-3d01-4b03-8b38-587aa0a27089.issuer.idp/authorize",
"tokenEndpoint" : "https://c90b14ed-3d01-4b03-8b38-587aa0a27089.issuer.idp/token",
"userInfoEndpoint" : "https://c90b14ed-3d01-4b03-8b38-587aa0a27089.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 776
{
"id" : "d3c3f7fa-d195-449d-b1ed-5bdecc449ef8",
"oidcIssuerId" : "2fdd1175-6a36-49a6-9933-a3606c659366",
"clientId" : "clientId-66c44c04-a79d-4fe4-ba10-90b376584bb4",
"clientSecret" : "clientSecret-ad3f8b9d-66fa-4e3c-a1fc-f47e872acd2f",
"authorizationEndpoint" : "https://c90b14ed-3d01-4b03-8b38-587aa0a27089.issuer.idp/authorize",
"tokenEndpoint" : "https://c90b14ed-3d01-4b03-8b38-587aa0a27089.issuer.idp/token",
"userInfoEndpoint" : "https://c90b14ed-3d01-4b03-8b38-587aa0a27089.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "1f6913f9-6395-47c4-ae30-0798d8fe6a98",
"createdAt" : {
"nano" : 875065000,
"epochSecond" : 1744903817
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Public Client
PATCH /oidc-public-clients/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients/79521205-8203-4f5b-bd3e-551cf626a65a' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"clientId" : "clientId-74aa5ff6-6e5c-4bf5-81c7-f69ec43af055",
"clientSecret" : "clientSecret-71bf2dde-c663-4fe1-991b-09620bf425a6",
"authorizationEndpoint" : "https://49de4777-db67-4ef2-a5b0-cb658b0f71c9.issuer.idp/authorize",
"tokenEndpoint" : "https://49de4777-db67-4ef2-a5b0-cb658b0f71c9.issuer.idp/token",
"userInfoEndpoint" : "https://49de4777-db67-4ef2-a5b0-cb658b0f71c9.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 777
{
"id" : "79521205-8203-4f5b-bd3e-551cf626a65a",
"oidcIssuerId" : "37e19647-b527-4b7c-92eb-d0e3e5cfd133",
"clientId" : "clientId-74aa5ff6-6e5c-4bf5-81c7-f69ec43af055",
"clientSecret" : "clientSecret-71bf2dde-c663-4fe1-991b-09620bf425a6",
"authorizationEndpoint" : "https://49de4777-db67-4ef2-a5b0-cb658b0f71c9.issuer.idp/authorize",
"tokenEndpoint" : "https://49de4777-db67-4ef2-a5b0-cb658b0f71c9.issuer.idp/token",
"userInfoEndpoint" : "https://49de4777-db67-4ef2-a5b0-cb658b0f71c9.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "ed16b611-5113-4f8c-a1a2-d49766e6df4d",
"createdAt" : {
"nano" : 809650000,
"epochSecond" : 1744903817
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Public Client
DELETE /oidc-public-clients/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients/c275f2f8-c550-4a95-9e18-9171af3122da' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 865
{
"id" : "c275f2f8-c550-4a95-9e18-9171af3122da",
"oidcIssuerId" : "89f91706-fcda-4359-8f56-6f834693dcf9",
"clientId" : "clientId-1ea7e166-2ccd-4236-92d0-e49cf2857327",
"clientSecret" : "clientSecret-1b6f7568-d1f2-4cb0-a70f-30b0e5a9a227",
"authorizationEndpoint" : "https://de00dfa1-207a-4ae9-85dc-5e3db05afedb.issuer.idp/authorize",
"tokenEndpoint" : "https://de00dfa1-207a-4ae9-85dc-5e3db05afedb.issuer.idp/token",
"userInfoEndpoint" : "https://de00dfa1-207a-4ae9-85dc-5e3db05afedb.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "ca024212-52fc-486d-bd99-602dda527653",
"createdAt" : {
"nano" : 988891000,
"epochSecond" : 1744903817
},
"deletedAt" : {
"nano" : 998947000,
"epochSecond" : 1744903817
},
"deletedBy" : "ea2f77f2-5528-4ac7-aaee-7a6d7e2cfaf1",
"deleted" : true
}
Organization to OIDC Public Client Mappings
Find Organization Oidc Public Client Mappings
GET /organization-oidc-public-client-mappings
Authorization
This endpoint requires:
-
read
action on thisorganization-oidc-public-client-mapping
resource.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1638
[ {
"id" : "56432b65-5d0e-4520-a960-d3a77d0df54d",
"organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "NetFoundry Google Account",
"active" : true,
"customQueryParameters" : "identityProviders=%5B%7B%22connectionId%22%3A%22google-oauth2%22%2C%22name%22%3A%22NetFoundry%20Google%20Account%22%7D%5D",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 869930000,
"epochSecond" : 1744903762
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "7df0a0da-9618-48fb-b22a-dd1e58960cc7",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"oidcPublicClientId" : "f4e6fcd0-1839-4566-8828-856e42b8f156",
"name" : "Google-Account",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "acfcc67f-16b3-4ad9-8f5f-ccfc7f22e038",
"createdAt" : {
"nano" : 946864000,
"epochSecond" : 1744903767
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "87e4548a-a1a7-4942-8486-f81bf8c24f8f",
"organizationId" : "f86122fb-316b-4427-8c38-248165bf4504",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "NFSUPPORT Google Account",
"active" : true,
"customQueryParameters" : "identityProviders=%5B%7B%22connectionId%22%3A%22google-oauth2%22%2C%22name%22%3A%22NFSUPPORT%20Google%20Account%22%7D%5D",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 775778000,
"epochSecond" : 1744903762
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Organization Oidc Public Client Mapping
GET /organization-oidc-public-client-mappings/{id}
Authorization
This endpoint requires:
-
read
action on thisorganization-oidc-public-client-mapping
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/8c7a1fb5-18e1-4f33-9dc0-d0c86055870b' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 493
{
"id" : "8c7a1fb5-18e1-4f33-9dc0-d0c86055870b",
"organizationId" : "e700a75b-363c-4f54-8ebe-66fcb9b0fa4f",
"oidcPublicClientId" : "c87bd9cd-a334-4fb2-9b2d-779cf007e853",
"name" : "console-client-065c5f13-4988-40ca-b5f7-755568195b41",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "f2d30acc-843d-4388-b629-af84a08f1b36",
"createdAt" : {
"nano" : 387842000,
"epochSecond" : 1744903819
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Organization Oidc Public Client Mapping
POST /organization-oidc-public-client-mappings
Authorization
This endpoint requires:
-
create
action on thisorganization-oidc-public-client-mapping
resource. -
read
action on theoidc-public-client
resource identified by theoidcPublicClientId
property.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "bff0f8a2-8ee1-4291-919d-256f63e642b8",
"oidcPublicClientId" : "40f1f821-7ca6-4da9-a3e0-0a92d689bc3e",
"name" : "console-client-e302bae4-4557-4631-ac26-5d523fc7cc1b",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 493
{
"id" : "de17ed4a-2a84-486b-b477-ed09d0f6f49c",
"organizationId" : "bff0f8a2-8ee1-4291-919d-256f63e642b8",
"oidcPublicClientId" : "40f1f821-7ca6-4da9-a3e0-0a92d689bc3e",
"name" : "console-client-e302bae4-4557-4631-ac26-5d523fc7cc1b",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "6eda0e3c-4d4a-4b36-a27f-5a5c6467f00f",
"createdAt" : {
"nano" : 339235000,
"epochSecond" : 1744903819
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Organization Oidc Public Client Mapping
PATCH /organization-oidc-public-client-mappings/{id}
Authorization
This endpoint requires:
-
update
action on thisorganization-oidc-public-client-mapping
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/44340efa-86f4-444d-8950-1e3095e2496a' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"name" : "custom-client-53995353-a79e-490d-bae9-be3a5910774b",
"active" : true
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "44340efa-86f4-444d-8950-1e3095e2496a",
"organizationId" : "c0b40675-dfab-4799-a72f-26d203e24134",
"oidcPublicClientId" : "de2a0005-a15c-4119-afe3-4324edae907a",
"name" : "custom-client-53995353-a79e-490d-bae9-be3a5910774b",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "bac5fe10-b8f0-4438-8c97-7e97b90ca373",
"createdAt" : {
"nano" : 259914000,
"epochSecond" : 1744903819
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Organization Oidc Public Client Mapping
DELETE /organization-oidc-public-client-mappings/{id}
Authorization
This endpoint requires:
-
delete
action on thisorganization-oidc-public-client-mapping
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/1bfc9a45-fe36-4ec6-a929-399e881d21c2' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 541
{
"id" : "1bfc9a45-fe36-4ec6-a929-399e881d21c2",
"organizationId" : "caa2c1d1-3f18-4da2-9824-d4ef596e57de",
"oidcPublicClientId" : "8c343e05-61dc-4490-a298-c5748b09bdf4",
"name" : "number two",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "c94df82f-524e-45f3-a5b9-9a1a4dcbbcc6",
"createdAt" : {
"nano" : 438924000,
"epochSecond" : 1744903819
},
"deletedAt" : {
"nano" : 450763000,
"epochSecond" : 1744903819
},
"deletedBy" : "9c4d22ea-7b54-4191-bb16-fae375be4dcc",
"deleted" : true
}
OIDC Audiences
Find Oidc Audiences
GET /oidc-audiences
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1280
[ {
"id" : "2b25ec7c-7983-4c48-a869-6a55f31e20f7",
"oidcIssuerId" : "9a2ba6c3-46cf-43dc-9c72-2f11e3f9b39c",
"audience" : "mop-aud-ce708be4-106c-4da6-8b9a-d75d6173a75f",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "69bedb82-38e7-4291-8f5c-bb1ff8b3e27d",
"createdAt" : {
"nano" : 370424000,
"epochSecond" : 1744903816
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "6a4f65ad-9db8-4ea7-b404-1d5c5f85cbdf",
"oidcIssuerId" : "fc221f2c-e97f-4994-a29e-afc26395f6b6",
"audience" : "https://gateway.{env}.netfoundry.io/",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 87558000,
"epochSecond" : 1744903763
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "b71d8edd-6bf1-4ed3-84e8-f3b5fe82868f",
"oidcIssuerId" : "6c72dba0-a155-4804-9a70-89da12149793",
"audience" : "https://gateway.{env}.netfoundry.io/",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 87558000,
"epochSecond" : 1744903763
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Oidc Audience
GET /oidc-audiences/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences/27814793-0e6c-4983-b180-5a1d0dbb6ade' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430
{
"id" : "27814793-0e6c-4983-b180-5a1d0dbb6ade",
"oidcIssuerId" : "dc2ebb39-b94d-4dc7-8e69-f7832f67a941",
"audience" : "mop-aud-8dd191cb-787d-4128-83a6-66d9135109d5",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "f76fba44-82b5-496e-86d2-4112d1afd8c1",
"createdAt" : {
"nano" : 807211000,
"epochSecond" : 1744903816
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Audience
POST /oidc-audiences
Request fields
Path | Type | Optional | Description |
---|---|---|---|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"oidcIssuerId" : "695e2354-f164-45d6-bedf-18cb757e7bbd",
"audience" : "mop-aud-8c08f503-9ae0-4a9f-9047-63d75b30328c",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "bb4b43b8-9415-4c6f-a93e-69d26b174f20",
"oidcIssuerId" : "695e2354-f164-45d6-bedf-18cb757e7bbd",
"audience" : "mop-aud-8c08f503-9ae0-4a9f-9047-63d75b30328c",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "b4809cc3-d48d-41dd-afb4-63ad00020da3",
"createdAt" : {
"nano" : 766752000,
"epochSecond" : 1744903816
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Audience
PATCH /oidc-audiences/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences/c763d206-060f-42ca-9b51-8d844dcd2820' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"audience" : "mop-aud-50b20031-9076-4255-aa1f-d3b1709f7674",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "c763d206-060f-42ca-9b51-8d844dcd2820",
"oidcIssuerId" : "3cb48c5d-4158-41de-9b15-3e9d4172e48a",
"audience" : "mop-aud-50b20031-9076-4255-aa1f-d3b1709f7674",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "ef7fee27-b5e7-47dd-97b2-3498675c1b0b",
"createdAt" : {
"nano" : 673030000,
"epochSecond" : 1744903816
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Audience
DELETE /oidc-audiences/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences/e03ce147-1064-408f-b4bc-e99c0d2087fd' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 519
{
"id" : "e03ce147-1064-408f-b4bc-e99c0d2087fd",
"oidcIssuerId" : "59eed01b-4021-499a-bbfe-0b1be6ffcb9b",
"audience" : "mop-aud-483214db-3121-47b1-b907-9d9345955c3a",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "7d9f5c76-8951-4d17-a96b-81258918984a",
"createdAt" : {
"nano" : 852508000,
"epochSecond" : 1744903816
},
"deletedAt" : {
"nano" : 864159000,
"epochSecond" : 1744903816
},
"deletedBy" : "83985a32-5848-43ae-996c-03dbc5514190",
"deleted" : true
}
User Identity to OIDC Audience Mappings
Find User Identity Audience Mappings
GET /user-identity-oidc-audience-mappings
Authorization
This endpoint requires:
-
read
action on thisuser-identity-oidc-audience-mapping
resource.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3
[ ]
Get User Identity Audience Mapping
GET /user-identity-oidc-audience-mappings/{id}
Authorization
This endpoint requires:
-
read
action on thisuser-identity-oidc-audience-mapping
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/96ff0ee3-5348-4d8d-8709-145dcb5d23c9' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 460
{
"id" : "96ff0ee3-5348-4d8d-8709-145dcb5d23c9",
"userIdentityId" : "1df448ca-3d51-42f0-8d58-1a2e05ad6bae",
"oidcAudienceId" : "688b46bc-5021-4212-b218-7b63bc4b9afd",
"subject" : "console-client-8059ae4b-a3be-49be-9c63-dc41368bedfb",
"active" : true,
"createdBy" : "f5f6dd97-3dc7-4ed3-922e-2e64659040ae",
"createdAt" : {
"nano" : 139218000,
"epochSecond" : 1744903822
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create User Identity Audience Mapping
POST /user-identity-oidc-audience-mappings
Authorization
This endpoint requires:
-
create
action on thisuser-identity-oidc-audience-mapping
resource. -
create-identity-mapping
action on theuser-identity
resource identified by theuserIdentityId
property. -
read
action on theoidc-audience
resource identified by theoidcAudienceId
property.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"userIdentityId" : "7de4fa74-6f50-40bf-800b-d288ae03a36e",
"oidcAudienceId" : "876e5313-8472-4c5c-9527-28c2c9c6f4b9",
"subject" : "console-client-3b91ab14-0e86-4160-b35d-edf2ae73dfe8",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 459
{
"id" : "a0ec89fd-a9e3-41f4-9feb-4f621ecc47d8",
"userIdentityId" : "7de4fa74-6f50-40bf-800b-d288ae03a36e",
"oidcAudienceId" : "876e5313-8472-4c5c-9527-28c2c9c6f4b9",
"subject" : "console-client-3b91ab14-0e86-4160-b35d-edf2ae73dfe8",
"active" : true,
"createdBy" : "460b97e6-3594-4729-a2e4-b6a97b466551",
"createdAt" : {
"nano" : 76730000,
"epochSecond" : 1744903822
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update User Identity Audience Mapping
PATCH /user-identity-oidc-audience-mappings/{id}
Authorization
This endpoint requires:
-
update
action on thisuser-identity-oidc-audience-mapping
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/4fe5a757-b6dc-42fe-b5c6-00fbe99acdec' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 461
{
"id" : "4fe5a757-b6dc-42fe-b5c6-00fbe99acdec",
"userIdentityId" : "71c563d1-6003-4415-98bb-adfe0328e215",
"oidcAudienceId" : "f3ad9156-a982-4157-aad0-6e92ad128f8a",
"subject" : "console-client-33b563f9-d095-4642-9a94-84b94f4797b4",
"active" : false,
"createdBy" : "1730bf1c-4c2a-41b8-b7ab-6d6cda8d9df1",
"createdAt" : {
"nano" : 989847000,
"epochSecond" : 1744903821
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete User Identity Audience Mapping
DELETE /user-identity-oidc-audience-mappings/{id}
Authorization
This endpoint requires:
-
delete
action on thisuser-identity-oidc-audience-mapping
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/e3980277-5d32-4e9a-a136-c813e91bb14c' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 549
{
"id" : "e3980277-5d32-4e9a-a136-c813e91bb14c",
"userIdentityId" : "7170ed74-220a-47d9-bee4-d18c22ca0fc9",
"oidcAudienceId" : "9d096c66-499e-4631-bd62-291c9619ab22",
"subject" : "console-client-27384adf-4f81-4bf4-a4b7-af66d89b5128",
"active" : true,
"createdBy" : "cd3d995a-b601-44d8-8223-cf01ac29b936",
"createdAt" : {
"nano" : 187499000,
"epochSecond" : 1744903822
},
"deletedAt" : {
"nano" : 197392000,
"epochSecond" : 1744903822
},
"deletedBy" : "0aabd859-5b75-4bb9-9fd5-208af19e0a86",
"deleted" : true
}
Identity Providers
Find Identity Providers
GET /identity-providers
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
organizationId |
Object |
true |
|
auth0ConnectionId |
Object |
true |
|
auth0ConnectionType |
Object |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
deleted |
Object |
true |
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1135
[ {
"id" : "289a738f-743b-45b3-a631-5b4d64b5fb09",
"organizationId" : "fdf0f327-7abd-4f33-854b-3b6f9f489fed",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 966873000,
"epochSecond" : 1744903814
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "2c79c691-0f58-4e76-8ecc-3fb8b73169c4",
"organizationId" : "5ad1c221-8af7-4dcd-8946-10d9edb818b2",
"auth0ConnectionId" : "auth0-opaque-connectionId-116",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 867790000,
"epochSecond" : 1744903812
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "34d2c619-14fd-46af-8368-f85925c38a6c",
"organizationId" : "dca32de4-eb48-4703-b89b-d3c89c97e01e",
"auth0ConnectionId" : "auth0-opaque-connectionId-34",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 242278000,
"epochSecond" : 1744903810
},
"updatedAt" : null,
"deletedAt" : null
} ]
Get Identity Provider
GET /identity-providers/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers/e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 373
{
"id" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 727751000,
"epochSecond" : 1744903767
},
"updatedAt" : null,
"deletedAt" : null
}
Create Identity Provider
POST /identity-providers
Request fields
Path | Type | Optional | Description |
---|---|---|---|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "fdf0f327-7abd-4f33-854b-3b6f9f489fed",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 368
{
"id" : "289a738f-743b-45b3-a631-5b4d64b5fb09",
"organizationId" : "fdf0f327-7abd-4f33-854b-3b6f9f489fed",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 966873000,
"epochSecond" : 1744903814
},
"updatedAt" : null,
"deletedAt" : null
}
Update Identity Provider
PUT /identity-providers/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers/ef1c9cf9-d6bf-4846-b16c-9c406a5cb779' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"name" : "New IdP Name"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "ef1c9cf9-d6bf-4846-b16c-9c406a5cb779",
"organizationId" : "756f35f9-1ebe-4613-bd0d-86cf05dc23fe",
"auth0ConnectionId" : "auth0-opaque-connectionId-209",
"name" : "New IdP Name",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 273586000,
"epochSecond" : 1744903815
},
"updatedAt" : {
"nano" : 297100000,
"epochSecond" : 1744903815
},
"deletedAt" : null
}
Activate Or Deactivate Identity Provider
PUT /identity-providers/{id}/{action:activate|deactivate}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers/a082a8d0-bea4-4c11-a5c0-001aced197f5/activate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 379
{
"id" : "a082a8d0-bea4-4c11-a5c0-001aced197f5",
"organizationId" : "608fd705-eb2d-4960-8ef0-1b4747cfc384",
"auth0ConnectionId" : "auth0-opaque-connectionId-203",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 90909000,
"epochSecond" : 1744903815
},
"updatedAt" : null,
"deletedAt" : null
}
Delete Identity Provider
DELETE /identity-providers/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers/69cd831f-c383-4216-87c2-051bbf06f376' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "69cd831f-c383-4216-87c2-051bbf06f376",
"organizationId" : "a19e9897-524d-4a46-a44d-2b7f700a461b",
"auth0ConnectionId" : "auth0-opaque-connectionId-207",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 215221000,
"epochSecond" : 1744903815
},
"updatedAt" : {
"nano" : 232217000,
"epochSecond" : 1744903815
},
"deletedAt" : {
"nano" : 231000000,
"epochSecond" : 1744903815
}
}
Default Roles
Find Default Roles
GET /default-roles
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
name |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1365
[ {
"id" : "020fa402-b383-4d89-aab8-df7a9f323857",
"organizationId" : "cc2433a9-c951-4a30-a57f-c23567fe7b87",
"name" : "NF Support - Observation",
"roleType" : "Custom",
"roleId" : "f1e3d5d9-2899-4df7-89ab-297d29cc54bc",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 803256000,
"epochSecond" : 1744903762
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "050f8a66-e013-478e-a037-26bde5731a7a",
"organizationId" : "f86122fb-316b-4427-8c38-248165bf4504",
"name" : "Standard Role Admin - Network Group Admin of NF Support (NFSUP)",
"roleType" : "Standard",
"roleId" : "ddd39147-0ce2-473d-93c7-25b1b404433d",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 818272000,
"epochSecond" : 1744903762
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "51453a68-d56e-46eb-83fe-02113d60117b",
"organizationId" : "f86122fb-316b-4427-8c38-248165bf4504",
"name" : "Network Group Admin - NF Support (NFSUP) Network Group",
"roleType" : "Standard",
"roleId" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 818272000,
"epochSecond" : 1744903762
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Default Role
GET /default-roles/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
name |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles/df8b8446-5c84-47ca-b6c1-ac87f1d5f35e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
{
"id" : "df8b8446-5c84-47ca-b6c1-ac87f1d5f35e",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "4dbb32b7-ec73-4fbf-aa38-138accc2f555",
"createdBy" : "544c2aaf-b6a0-4e3e-b9eb-d1a6f6a64e22",
"createdAt" : {
"nano" : 992530000,
"epochSecond" : 1744903767
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Default Role
POST /default-roles
Authorization
This endpoint requires:
-
create
action on thisdefault-role
resource. -
update
action on theorganization
resource identified by theorganization
property.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
organizationId |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
name |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "eb83aed9-96d0-4c17-bf6e-8c5b8e24ed70",
"roleType" : "Standard",
"roleId" : "b8430441-f7b8-46f2-932c-bd05d0f4a0c4"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 457
{
"id" : "d09bcdef-b89e-4a49-bc7a-c660ecd91c88",
"organizationId" : "eb83aed9-96d0-4c17-bf6e-8c5b8e24ed70",
"name" : "Standard Role - b8430441-f7b8-46f2-932c-bd05d0f4a0c4",
"roleType" : "Standard",
"roleId" : "b8430441-f7b8-46f2-932c-bd05d0f4a0c4",
"createdBy" : "fee97476-e81d-48e6-bc81-78bc33708b38",
"createdAt" : {
"nano" : 59729000,
"epochSecond" : 1744903811
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Default Role
DELETE /default-roles/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
name |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles/4f052594-59d4-4df5-b521-e8363ee15623' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "4f052594-59d4-4df5-b521-e8363ee15623",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "Test Deletion",
"roleType" : "Standard",
"roleId" : "e0872473-392b-4f4f-9eb7-511df6eba5be",
"createdBy" : "4fa17aea-6017-4e38-92c1-618db0b017ac",
"createdAt" : {
"nano" : 713740000,
"epochSecond" : 1744903810
},
"deletedAt" : {
"nano" : 734000000,
"epochSecond" : 1744903810
},
"deletedBy" : "854ce52d-86bf-40c1-af43-b7e39ad664b0",
"deleted" : true
}
Grant Default Role
POST /default-roles/{id}/grant
Authorization
This endpoint requires:
-
read
action on thisdefault-role
resource. -
create
action on theinvitation
resource identified by theorganization
property.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles/8ef0cf5a-302c-46c3-9069-9385f50fce2c/grant' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"includeIdentityIds" : [ "10922276-775c-4d28-a51b-a7e933abdd92", "504ae8ed-02ba-4a44-8d92-c5198bba1965", "f12c1090-1afd-45c8-9320-336a4788fd6b" ],
"excludeIdentityIds" : [ "10922276-775c-4d28-a51b-a7e933abdd92", "8e863449-30ea-4540-9239-aa9957a42bba", "f12c1090-1afd-45c8-9320-336a4788fd6b" ]
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51
{
"504ae8ed-02ba-4a44-8d92-c5198bba1965" : true
}
User Identity
Get Identity
GET /identities/self
Authorization
This endpoint requires no specific permission, only an authenticated client.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
id |
String |
true |
|
type |
String |
true |
|
active |
Boolean |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
organizationId |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identities/self' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 718
{
"id" : "23c7894c-b5ba-4a86-91dc-3931b1dd55a7",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-301@acme.com",
"identityMappings" : [ {
"id" : "c83ae727-737c-44e1-a540-6827a122d72e",
"auth0UserId" : "auth0-opaque-userId-302",
"identityProviderId" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"userIdentityId" : "23c7894c-b5ba-4a86-91dc-3931b1dd55a7"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 687391000,
"epochSecond" : 1744903820
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}
Get Identity
GET /identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
id |
String |
true |
|
type |
String |
true |
|
active |
Boolean |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
organizationId |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identities/cff6d0ac-59ed-4615-b30d-b4f446f468ba' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "4a3ccee4-54cc-46ca-bba5-da5f0f275892",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "e87c4976-eec1-409c-b88d-4f470460b1c6",
"userIdentityId" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 130005000,
"epochSecond" : 1744903768
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}
Find User Identities
GET /user-identities
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities' -i -X GET
Example response
HTTP/1.1 200 OK
Link: <https://gateway.netFoundry.io/identity/v1/user-identities?page=1>; rel="next", <https://gateway.netFoundry.io/identity/v1/user-identities?page=4>; rel="last"
Content-Type: application/json
Content-Length: 2171
[ {
"id" : "00e93111-c95a-477a-8c00-6d02cab35032",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "TESTING",
"lastName" : "CLIENT",
"email" : "test.client@server.com",
"identityMappings" : [ {
"id" : "a969fb50-a20c-4faf-9cee-059a2a0724c8",
"auth0UserId" : "auth0-opaque-userId-6",
"identityProviderId" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"userIdentityId" : "00e93111-c95a-477a-8c00-6d02cab35032"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 236336000,
"epochSecond" : 1744903768
},
"deletedAt" : null,
"name" : "TESTING CLIENT",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}, {
"id" : "23aa192b-1630-4cd5-b63c-522e6aaf33e2",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-95@acme.com",
"identityMappings" : [ {
"id" : "b8b1d523-5a84-4572-9316-3f1130e90a84",
"auth0UserId" : "auth0-opaque-userId-96",
"identityProviderId" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"userIdentityId" : "23aa192b-1630-4cd5-b63c-522e6aaf33e2"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 265792000,
"epochSecond" : 1744903812
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}, {
"id" : "2517c358-d75c-4dbd-b9cd-17eb4410da09",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com",
"identityMappings" : [ {
"id" : "560ae4e1-e7f5-458b-8079-c0f21cb7d0d3",
"auth0UserId" : "auth0-opaque-userId-82",
"identityProviderId" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"userIdentityId" : "2517c358-d75c-4dbd-b9cd-17eb4410da09"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 455943000,
"epochSecond" : 1744903811
},
"deletedAt" : null,
"name" : "Bobby White",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
} ]
Get User Identity
GET /user-identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/cff6d0ac-59ed-4615-b30d-b4f446f468ba' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "4a3ccee4-54cc-46ca-bba5-da5f0f275892",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "e87c4976-eec1-409c-b88d-4f470460b1c6",
"userIdentityId" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 130005000,
"epochSecond" : 1744903768
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}
Get User Identity By Mapping
GET /user-identities/mapping/{auth0UserId}/{identityProviderId}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
auth0UserId |
String |
false |
|
identityProviderId |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/mapping/auth0-opaque-userId-3/e87c4976-eec1-409c-b88d-4f470460b1c6' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "4a3ccee4-54cc-46ca-bba5-da5f0f275892",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "e87c4976-eec1-409c-b88d-4f470460b1c6",
"userIdentityId" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 130005000,
"epochSecond" : 1744903768
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}
Create Identity
POST /user-identities
Request fields
Path | Type | Optional | Description |
---|---|---|---|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 479
{
"id" : "d9d3b42e-e4a4-48ff-8c86-22d868f15c01",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com",
"identityMappings" : [ ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 382998000,
"epochSecond" : 1744903821
},
"deletedAt" : null,
"name" : "Jane Doe",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}
Update
PUT /user-identities/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/115cfdef-de0e-40b1-acd4-55627d936632' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 721
{
"id" : "115cfdef-de0e-40b1-acd4-55627d936632",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com",
"identityMappings" : [ {
"id" : "136a0c20-34ac-4055-9e1e-93805f93850f",
"auth0UserId" : "auth0-opaque-userId-306",
"identityProviderId" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"userIdentityId" : "115cfdef-de0e-40b1-acd4-55627d936632"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 869373000,
"epochSecond" : 1744903820
},
"deletedAt" : null,
"name" : "Bobby White",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}
Activate Or Deactivate User Identity
PUT /user-identities/{id}/{action:activate|deactivate}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/2f574563-d035-4cb6-a623-1f1bb0fb7e75/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 719
{
"id" : "2f574563-d035-4cb6-a623-1f1bb0fb7e75",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-307@acme.com",
"identityMappings" : [ {
"id" : "51d37706-7a0a-4594-a85c-f2ab9167cf4c",
"auth0UserId" : "auth0-opaque-userId-308",
"identityProviderId" : "e0dc320e-1c6d-4bf7-b9af-c0c3bd0d2648",
"userIdentityId" : "2f574563-d035-4cb6-a623-1f1bb0fb7e75"
} ],
"identityAudienceMappings" : [ ],
"active" : false,
"createdAt" : {
"nano" : 919217000,
"epochSecond" : 1744903820
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "UserIdentity"
}
Reset User Identity Mfa Settings
PUT /user-identities/{id}/reset-mfa
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/2e8928a1-ec88-447e-8ac6-6d1977c4dc0c/reset-mfa' -i -X PUT
Example response
HTTP/1.1 200 OK
Map Identity
POST /user-identities/{id}/mapping
Authorization
This endpoint requires:
-
create-identity-mapping
action on thisuser-identity
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
auth0UserId |
String |
true |
|
identityProviderId |
String |
true |
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/13966154-94df-4972-a486-f5e8d6a6522d/mapping' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"auth0UserId" : "new-auth0-userId:d16cd37a-9c5e-4ef0-a554-d04dba0fdbf4",
"identityProviderId" : "e87c4976-eec1-409c-b88d-4f470460b1c6"
}'
Example response
HTTP/1.1 200 OK
API Account Identity
Find Api Account Identities
GET /api-account-identities
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
tenantId |
Object |
true |
Deprecated.. |
organizationId |
Object |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
active |
Boolean |
true |
|
includeDeleted |
Boolean |
true |
Default value: 'false'. |
provider |
String |
true |
Must be one of [Auth0, Cognito]. |
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities' -i -X GET
Example response
HTTP/1.1 200 OK
Link: <https://gateway.netFoundry.io/identity/v1/api-account-identities?page=1>; rel="next", <https://gateway.netFoundry.io/identity/v1/api-account-identities?page=2>; rel="last"
Content-Type: application/json
Content-Length: 2165
[ {
"id" : "02430c8b-5cc2-4b2e-84cf-61d3363fd5ab",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ClientId" : null,
"awsCognitoClientId" : "b0b7e979-e3c8-40a2-b5a9-2b96663a9d41|beiaoklw",
"authenticationUrl" : "https://netfoundry-test-vxbqpk.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 560608000,
"epochSecond" : 1744903780
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "ApiAccountIdentity"
}, {
"id" : "05007ff2-a1fd-4392-a24a-bdbcc3665e68",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ClientId" : "ca351432-eb5f-41c5-aacd-bf76fe958c8f",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "ACME Internal Service-11",
"contactEmail" : "service.admin-12@acme.com",
"description" : "updatable API Account description-13",
"active" : true,
"createdAt" : {
"nano" : 539019000,
"epochSecond" : 1744903771
},
"updatedAt" : {
"nano" : 565136000,
"epochSecond" : 1744903771
},
"deletedAt" : null,
"email" : "service.admin-12@acme.com",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "ApiAccountIdentity"
}, {
"id" : "118f2c8b-bdd2-4b6e-b1c3-efd30979a4a0",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ClientId" : null,
"awsCognitoClientId" : "4258019e-901a-4955-b5c6-ed9fb558b37d|pkkbhyfq",
"authenticationUrl" : "https://netfoundry-test-vwyadn.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Test Rotation",
"contactEmail" : "hr.director@acme.com",
"description" : "description goes here",
"active" : true,
"createdAt" : {
"nano" : 123820000,
"epochSecond" : 1744903774
},
"updatedAt" : {
"nano" : 151006000,
"epochSecond" : 1744903775
},
"deletedAt" : null,
"email" : "hr.director@acme.com",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "ApiAccountIdentity"
} ]
Get Api Account Identity
GET /api-account-identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/506b2b80-3d20-4aa7-8324-f578a214827f' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 718
{
"id" : "506b2b80-3d20-4aa7-8324-f578a214827f",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ClientId" : "2ee1df83-68cb-4dab-b1a5-83ad63f9aecf",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "api-account",
"contactEmail" : "no-reply@acme.com",
"description" : "This is an ACME non-interactive API client.",
"active" : true,
"createdAt" : {
"nano" : 194092000,
"epochSecond" : 1744903768
},
"updatedAt" : {
"nano" : 926437000,
"epochSecond" : 1744903770
},
"deletedAt" : null,
"email" : "no-reply@acme.com",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "ApiAccountIdentity"
}
Get Api Account Identity By Mapping
GET /api-account-identities/mapping/{clientId}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
clientId |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/mapping/bbf923a4-5aab-4bfe-9400-f4a078bacdbf' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 682
{
"id" : "ca8feff5-d323-4f1c-a29f-2bea9b122e0b",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ClientId" : "bbf923a4-5aab-4bfe-9400-f4a078bacdbf",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "ACME Internal Service-29",
"contactEmail" : "service.admin-30@foo.com",
"description" : "updatable API Account description-31",
"active" : true,
"createdAt" : {
"nano" : 798493000,
"epochSecond" : 1744903809
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "service.admin-30@foo.com",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "ApiAccountIdentity"
}
Create Api Account Identity
POST /api-account-identities
Request fields
Path | Type | Optional | Description |
---|---|---|---|
organizationId |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
grantDefaultRoles |
Boolean |
true |
|
provider |
String |
true |
Must be one of [Auth0, Cognito]. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
apiAccountIdentity |
Object |
true |
|
apiAccountIdentity.id |
String |
true |
|
apiAccountIdentity.organizationId |
String |
true |
|
apiAccountIdentity.auth0ClientId |
String |
true |
|
apiAccountIdentity.awsCognitoClientId |
String |
true |
|
apiAccountIdentity.authenticationUrl |
String |
true |
|
apiAccountIdentity.name |
String |
true |
|
apiAccountIdentity.contactEmail |
String |
true |
|
apiAccountIdentity.description |
String |
true |
|
apiAccountIdentity.active |
Boolean |
true |
|
apiAccountIdentity.createdAt |
Object |
true |
|
apiAccountIdentity.updatedAt |
Object |
true |
|
apiAccountIdentity.deletedAt |
Object |
true |
|
apiAccountIdentity.email |
String |
true |
|
apiAccountIdentity.tenantId |
String |
true |
Deprecated.. |
apiAccountIdentity.type |
String |
true |
|
clientId |
String |
true |
|
password |
String |
true |
|
authenticationUrl |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"name" : "HR Bridge Service",
"contactEmail" : "hr.director@acme.com",
"description" : "description goes here",
"grantDefaultRoles" : true,
"provider" : "Cognito"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 940
{
"apiAccountIdentity" : {
"id" : "53e34fca-d2cf-470a-ab29-b814f57c9701",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ClientId" : null,
"awsCognitoClientId" : "4258019e-901a-4955-b5c6-ed9fb558b37d|hykmtaet",
"authenticationUrl" : "https://netfoundry-test-vwyadn.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "HR Bridge Service",
"contactEmail" : "hr.director@acme.com",
"description" : "description goes here",
"active" : true,
"createdAt" : {
"nano" : 548787000,
"epochSecond" : 1744903775
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "hr.director@acme.com",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "ApiAccountIdentity"
},
"clientId" : "hykmtaet",
"password" : "ytgngopnlhettthmqumujayh",
"authenticationUrl" : "https://netfoundry-test-vwyadn.auth.us-east-1.amazoncognito.com/oauth2/token"
}
Update Identity Info
PUT /api-account-identities/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/85685abb-a7d7-490e-b7d2-9a14dcd319dd' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"name" : "Robot",
"contactEmail" : "robot@acme.com",
"description" : "description here."
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 680
{
"id" : "85685abb-a7d7-490e-b7d2-9a14dcd319dd",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ClientId" : "46417239-63e5-4218-b0da-901cff33b828",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "Robot",
"contactEmail" : "robot@acme.com",
"description" : "description here.",
"active" : true,
"createdAt" : {
"nano" : 294734000,
"epochSecond" : 1744903768
},
"updatedAt" : {
"nano" : 540894000,
"epochSecond" : 1744903769
},
"deletedAt" : null,
"email" : "robot@acme.com",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "ApiAccountIdentity"
}
Activate Or Deactivate Api Account Identity
PUT /api-account-identities/{id}/{action:activate|deactivate}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/93ea2847-c54c-4e25-9f11-9d502d5b83a5/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 739
{
"id" : "93ea2847-c54c-4e25-9f11-9d502d5b83a5",
"organizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"auth0ClientId" : "dd8540cb-0e8b-420f-9549-08fcb795341d",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "ACME Internal Service-23",
"contactEmail" : "service.admin-24@foo.com",
"description" : "updatable API Account description-25",
"active" : false,
"createdAt" : {
"nano" : 540101000,
"epochSecond" : 1744903809
},
"updatedAt" : {
"nano" : 575459000,
"epochSecond" : 1744903809
},
"deletedAt" : null,
"email" : "service.admin-24@foo.com",
"tenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"type" : "ApiAccountIdentity"
}
Invitation
Find Invitations
GET /invitations
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
fromIdentityId |
Object |
true |
|
toTenantId |
Object |
true |
Deprecated.. |
toOrganizationId |
Object |
true |
|
invitedEmailAddress |
String |
true |
|
targetIdentityId |
Object |
true |
|
states |
Object |
true |
Must be one of [Open, Accepted, Declined, Expired, Revoked]. |
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 527
[ {
"id" : "368018b7-b10e-4bf4-a58a-cedd589d78ff",
"fromIdentityId" : "8b996f6f-d4bd-49ea-a17e-24792d9a1050",
"toOrganizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 512198000,
"epochSecond" : 1745508615
},
"targetUserIdentityId" : "d704fafa-23f0-4e6a-9a01-5ccf27e63bd3",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822"
} ]
Get Invitation By Id
GET /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/1923d0ae-af97-492c-8ef9-87291f614713' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 527
{
"id" : "1923d0ae-af97-492c-8ef9-87291f614713",
"fromIdentityId" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba",
"toOrganizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"invitedEmailAddress" : "new.employee-219@acme.com",
"expiration" : {
"nano" : 753835000,
"epochSecond" : 1745508615
},
"targetUserIdentityId" : "77481382-9370-4a52-9ccc-7adce986a81e",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822"
}
Create Invitation
POST /invitations
Authorization
This endpoint requires:
-
create
action on thisinvitation
resource. -
read
action on theuser-identity
resource identified by thetargetUserIdentityId
property.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
invitationUrl |
String |
true |
|
targetUserIdentityId |
String |
true |
|
brandingOrganizationId |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"toOrganizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"invitedEmailAddress" : "new.employee@acme.com",
"invitationUrl" : "http://acme.console.netfoundry.io/invitation",
"targetUserIdentityId" : "d704fafa-23f0-4e6a-9a01-5ccf27e63bd3",
"brandingOrganizationId" : null
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 523
{
"id" : "368018b7-b10e-4bf4-a58a-cedd589d78ff",
"fromIdentityId" : "8b996f6f-d4bd-49ea-a17e-24792d9a1050",
"toOrganizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 512198000,
"epochSecond" : 1745508615
},
"targetUserIdentityId" : "d704fafa-23f0-4e6a-9a01-5ccf27e63bd3",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822"
}
Respond To Invitation
PUT /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}/{action:accept|decline}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/a532b2fa-ac1f-4682-8c76-992553359556/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 588
{
"id" : "a532b2fa-ac1f-4682-8c76-992553359556",
"fromIdentityId" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba",
"toOrganizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"invitedEmailAddress" : "new.employee-216@acme.com",
"expiration" : {
"nano" : 695786000,
"epochSecond" : 1745508615
},
"targetUserIdentityId" : "f1359c1a-d7be-4757-bd7e-b5b3134d2278",
"accepted" : false,
"revokedAt" : null,
"responseReceivedAt" : {
"nano" : 707451000,
"epochSecond" : 1744903815
},
"state" : "Declined",
"toTenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822"
}
Revoke Invitation
PUT /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}/revoke
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/36085f8a-96e0-4dac-aaaa-c06cee1ae3dd/revoke' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 642
{
"id" : "36085f8a-96e0-4dac-aaaa-c06cee1ae3dd",
"fromIdentityId" : "cff6d0ac-59ed-4615-b30d-b4f446f468ba",
"toOrganizationId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822",
"invitedEmailAddress" : "new.employee-222@acme.com",
"expiration" : {
"nano" : 799273000,
"epochSecond" : 1745508615
},
"targetUserIdentityId" : "eb755aac-b9e2-4bc5-82ab-afc8f57b6639",
"accepted" : null,
"revokedAt" : {
"nano" : 809698000,
"epochSecond" : 1744903815
},
"responseReceivedAt" : {
"nano" : 809702000,
"epochSecond" : 1744903815
},
"state" : "Revoked",
"toTenantId" : "4dc8bd55-6119-4f2b-ac2b-b97f8f1e7822"
}
Support
Create Support Request
POST /nfconsole/support/requests
Authorization
Authorization not required for this request.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
String |
true |
||
selectedOrganizationId |
String |
true |
|
selectedNetworkId |
String |
true |
|
subject |
String |
true |
|
comment |
String |
true |
|
type |
String |
true |
Must be one of [problem, incident, question, task]. |
priority |
String |
true |
Must be one of [urgent, high, normal, low]. |
severity |
String |
true |
Must be one of [Severity1, Severity2, Severity3]. |
recentErrorMessages |
Array[String] |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/nfconsole/support/requests' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"name" : "Curious George",
"email" : "george@curious-client.com",
"selectedOrganizationId" : null,
"selectedNetworkId" : null,
"subject" : "Sales Contact Request",
"comment" : "This looks great! I'd like a sales rep to contact me.",
"type" : "question",
"priority" : "high",
"severity" : "Severity3",
"recentErrorMessages" : null
}'
Example response
HTTP/1.1 200 OK
Invitation Flow
Get Invitation By Key
GET /invitations/key/{key:\p{Alnum}{36}}
Authorization
Authorization not required for this request.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
key |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
fromIdentity |
Object |
true |
|
fromIdentity.name |
String |
true |
|
fromIdentity.email |
String |
true |
|
targetIdentity |
Object |
true |
|
targetIdentity.name |
String |
true |
|
targetIdentity.email |
String |
true |
|
invitedEmailAddress |
String |
true |
|
toOrganizationName |
String |
true |
|
toOrganizationLabel |
String |
true |
|
expiration |
Object |
true |
|
accepted |
Boolean |
true |
|
state |
String |
true |
Must be one of [Open, Accepted, Declined, Expired, Revoked]. |
toTenantName |
String |
true |
Deprecated.. |
toTenantLabel |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/key/JxFkzV2XKw2W5IxNNXjKXm5mvN7bQVm9iK5O' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 519
{
"fromIdentity" : {
"name" : "John Doe",
"email" : "john.doe@acme.com"
},
"targetIdentity" : {
"name" : "First Last",
"email" : "random-229@acme.com"
},
"invitedEmailAddress" : "new.employee-231@acme.com",
"toOrganizationName" : "ACME International, Inc.",
"toOrganizationLabel" : "ACME-0",
"expiration" : {
"nano" : 141671000,
"epochSecond" : 1745508616
},
"accepted" : null,
"state" : "Open",
"toTenantName" : "ACME International, Inc.",
"toTenantLabel" : "ACME-0"
}
Decline Invitation
PUT /invitations/key/{key:\p{Alnum}{36}}/decline
Authorization
Authorization not required for this request.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
key |
String |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
fromIdentity |
Object |
true |
|
fromIdentity.name |
String |
true |
|
fromIdentity.email |
String |
true |
|
targetIdentity |
Object |
true |
|
targetIdentity.name |
String |
true |
|
targetIdentity.email |
String |
true |
|
invitedEmailAddress |
String |
true |
|
toOrganizationName |
String |
true |
|
toOrganizationLabel |
String |
true |
|
expiration |
Object |
true |
|
accepted |
Boolean |
true |
|
state |
String |
true |
Must be one of [Open, Accepted, Declined, Expired, Revoked]. |
toTenantName |
String |
true |
Deprecated.. |
toTenantLabel |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/key/4zkmnntZp5asISrSwnofSi1BSKTPKhddSsSP/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 523
{
"fromIdentity" : {
"name" : "John Doe",
"email" : "john.doe@acme.com"
},
"targetIdentity" : {
"name" : "First Last",
"email" : "random-226@acme.com"
},
"invitedEmailAddress" : "new.employee-228@acme.com",
"toOrganizationName" : "ACME International, Inc.",
"toOrganizationLabel" : "ACME-0",
"expiration" : {
"nano" : 74900000,
"epochSecond" : 1745508616
},
"accepted" : false,
"state" : "Declined",
"toTenantName" : "ACME International, Inc.",
"toTenantLabel" : "ACME-0"
}
Initiate Accept Invitation
POST /invitations/key/{key:\p{Alnum}{36}}/accept-initiate
Authorization
Authorization not required for this request.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
key |
String |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
intermediateReturnUrl |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
nfToken |
String |
true |
|
auth0ConnectionIds |
Array[String] |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/key/VVmKsQhEsJiCniBR6CXwFeVx12zdbcwRq1B0/accept-initiate' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"intermediateReturnUrl" : "http://console.nfadmin.netfoundry.io/invitation"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 981
{
"nfToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NDQ5MDM4MTUsImV4cCI6MTc0NDkwNDcxNSwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJpbnZpdGF0aW9uIiwiaW52aXRhdGlvbklkIjoiZTRhNDdmMjYtZDNlNC00NjU2LTk5NWEtMDhmMzNlNTFlMWMzIiwidGVuYW50TGFiZWwiOiJBQ01FLTAiLCJhdXRoMENvbm5lY3Rpb25JZHMiOlsiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0yIiwiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0xIl0sInJlZGlyZWN0VXJsIjoiaHR0cDovL2NvbnNvbGUubmZhZG1pbi5uZXRmb3VuZHJ5LmlvL2ludml0YXRpb24ifQ.PpKVea_q25GYvlvM9eLpejxSEtXCzrUinrCFv2qFHg8hmjEMVziiNsEJPutvxndWWJ4g9lGq0e7HtuuQeSpPlHr5eQANea7sqVp0Ka9FqvayEYlVj1UFjb63fkJ7ZvQFLRpz_-2p7GCG4fLhivO82hVOLPVL0JsXh7wX2FvPaX3PBpgz3M2NWjvRPNlqNo86WDmGkEQgoN1pyZKfTs0en5jcMVbvF6juruhQM62B1mWgzHATvO0XyCV0T5RS1uR38QEBS98fDmZHyvehXgQSR3LXa0paBdGOriwpZUOconUrB5cMulXHVYy0RCnegb8gSN0FfkuvrZxv0CZG8CcdMA",
"auth0ConnectionIds" : [ "auth0-opaque-connectionId-2", "auth0-opaque-connectionId-1" ]
}
Login Flow
Initiate Interactive Authorization
POST /organizations/authorize-initiate
Authorization
Authorization not required for this request.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
label |
String |
true |
|
intermediateReturnUrl |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
nfToken |
String |
true |
|
auth0ConnectionIds |
Array[String] |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/authorize-initiate' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"label" : "ACME-0",
"intermediateReturnUrl" : "http://console.nfadmin.netfoundry.io/invitation"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 902
{
"nfToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NDQ5MDM4MTYsImV4cCI6MTc0NDkwNDcxNiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJsb2dpbiIsInRlbmFudExhYmVsIjoiQUNNRS0wIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMiIsImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMSJdLCJyZWRpcmVjdFVybCI6Imh0dHA6Ly9jb25zb2xlLm5mYWRtaW4ubmV0Zm91bmRyeS5pby9pbnZpdGF0aW9uIn0.d49xjgr9lpEUwmL27SSzbi4e5fXdFkNUUsRPeRkcuKIGlxFC8ujMh5TGsdGpNhSCwR2GyvC636Tx1jn0c2HLrv9CW9ehYrNCg3Bag2HxSWqEnVpYlvE2CRifygA_T5sSRKBgvHEx7_k7QjlgkmvMoZEWb-pBGyTXG1n3O6K7V9ApJW7muCVimHYZ_vqCazwMP8R_7z68859IXad8loF39_pJEgK88AjFvSDZJwleTCO6u1VHuYP7eLgiQ4G4kCQv-OF279-bK7PXmyYIoJvy05UUZ3k-ukwwwRPAVL-NjDhjsaSGjvV-Rkz4Voe4fy0Qm1irOy_O9iePyUKnjZJTpw",
"auth0ConnectionIds" : [ "auth0-opaque-connectionId-2", "auth0-opaque-connectionId-1" ]
}
Identity Preference Flow
Find Identity Preferences
GET /identity-preferences
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1281
[ {
"id" : "74eb6f21-a668-4e04-a957-87a4b78e69c1",
"userIdentityId" : "a0b8aa8d-caee-4bd2-821d-e4db5de7f7cd",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "a0b8aa8d-caee-4bd2-821d-e4db5de7f7cd",
"createdAt" : {
"nano" : 128835000,
"epochSecond" : 1744903812
},
"updatedAt" : {
"nano" : 128835000,
"epochSecond" : 1744903812
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "bdf3db64-34dc-4985-a42c-adc2bf5e8e75",
"userIdentityId" : "b67f4133-4d53-4841-8724-0d91cef642e7",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "b67f4133-4d53-4841-8724-0d91cef642e7",
"createdAt" : {
"nano" : 21483000,
"epochSecond" : 1744903812
},
"updatedAt" : {
"nano" : 21483000,
"epochSecond" : 1744903812
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "c81e793c-cfeb-4277-afda-99ff876359ec",
"userIdentityId" : "23aa192b-1630-4cd5-b63c-522e6aaf33e2",
"preferences" : {
"hello" : "world"
},
"createdBy" : "23aa192b-1630-4cd5-b63c-522e6aaf33e2",
"createdAt" : {
"nano" : 276812000,
"epochSecond" : 1744903812
},
"updatedAt" : {
"nano" : 276812000,
"epochSecond" : 1744903812
},
"deletedBy" : null,
"deletedAt" : null
} ]
Get Identity Preference
GET /identity-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences/60a55d70-5299-473d-a064-00fee9f1be8d' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "60a55d70-5299-473d-a064-00fee9f1be8d",
"userIdentityId" : "ae748cd4-eb81-408a-9800-860bb5630e99",
"preferences" : {
"hello" : "world"
},
"createdBy" : "ae748cd4-eb81-408a-9800-860bb5630e99",
"createdAt" : {
"nano" : 413552000,
"epochSecond" : 1744903813
},
"updatedAt" : {
"nano" : 413552000,
"epochSecond" : 1744903813
},
"deletedBy" : null,
"deletedAt" : null
}
Upsert Identity Preference
POST /identity-preferences
Authorization
This endpoint requires no specific permission, only an authenticated client.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"userIdentityId" : null,
"preferences" : {
"first" : "my first preference."
}
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "dd36efb9-548d-476e-bf37-722690dc9c35",
"userIdentityId" : "9bcc7a6d-6f08-47f5-850f-1190df793a8a",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "9bcc7a6d-6f08-47f5-850f-1190df793a8a",
"createdAt" : {
"nano" : 662632000,
"epochSecond" : 1744903812
},
"updatedAt" : {
"nano" : 662632000,
"epochSecond" : 1744903812
},
"deletedBy" : null,
"deletedAt" : null
}
Upsert Identity Preference By Id
PUT /identity-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Authorization
This endpoint requires:
-
create
action on thisidentity-preference
resource. -
update
action on thisidentity-preference
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences/ea8d0217-5689-4d4a-b7fb-c7f2b7f11202' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"preferences" : {
"updated" : "my second preference."
}
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 433
{
"id" : "ea8d0217-5689-4d4a-b7fb-c7f2b7f11202",
"userIdentityId" : "902d95f4-2bdd-4e7e-a03d-2c11cac214fd",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "902d95f4-2bdd-4e7e-a03d-2c11cac214fd",
"createdAt" : {
"nano" : 221072000,
"epochSecond" : 1744903814
},
"updatedAt" : {
"nano" : 233448000,
"epochSecond" : 1744903814
},
"deletedBy" : null,
"deletedAt" : null
}
Delete Identity Preference By Id
DELETE /identity-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences/dfed3a57-4c4a-4b81-a812-1de053cd5adc' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 502
{
"id" : "dfed3a57-4c4a-4b81-a812-1de053cd5adc",
"userIdentityId" : "a57462a9-285a-4249-9b0b-0b302cbb9d22",
"preferences" : {
"hello" : "world"
},
"createdBy" : "a57462a9-285a-4249-9b0b-0b302cbb9d22",
"createdAt" : {
"nano" : 18709000,
"epochSecond" : 1744903813
},
"updatedAt" : {
"nano" : 29868000,
"epochSecond" : 1744903813
},
"deletedBy" : "5904b856-381e-41a9-9c2c-9545180d1ae4",
"deletedAt" : {
"nano" : 29000000,
"epochSecond" : 1744903813
}
}
Organization Preference Flow
Find Organization Preferences
GET /organization-preferences
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1268
[ {
"id" : "756d3f06-d4af-4d34-b5c7-b282703653a0",
"organizationId" : "318f8815-c3bc-4f20-a14b-45310fc18202",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "7e19a565-3dbd-46a0-8bf3-9ad3df9a8512",
"createdAt" : {
"nano" : 789928000,
"epochSecond" : 1744903819
},
"updatedAt" : {
"nano" : 789928000,
"epochSecond" : 1744903819
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "a2882e8c-240f-46e5-8434-75902f5da0e4",
"organizationId" : "b22d10b0-4087-4fb3-a0b1-879342e2cee5",
"preferences" : {
"hello" : "world"
},
"createdBy" : "d394beb0-880a-4a68-9ea3-2bc6981bccbf",
"createdAt" : {
"nano" : 862148000,
"epochSecond" : 1744903819
},
"updatedAt" : {
"nano" : 862148000,
"epochSecond" : 1744903819
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "baef013a-8356-4572-91bc-06eb32111901",
"organizationId" : "e7231fcb-67d1-4e85-b069-ffe672160d12",
"preferences" : {
"hello" : "world"
},
"createdBy" : "1684b478-a5a7-400e-b735-147f18dbd711",
"createdAt" : {
"nano" : 719231000,
"epochSecond" : 1744903819
},
"updatedAt" : {
"nano" : 719231000,
"epochSecond" : 1744903819
},
"deletedBy" : null,
"deletedAt" : null
} ]
Get Organization Preference
GET /organization-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences/a2882e8c-240f-46e5-8434-75902f5da0e4' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "a2882e8c-240f-46e5-8434-75902f5da0e4",
"organizationId" : "b22d10b0-4087-4fb3-a0b1-879342e2cee5",
"preferences" : {
"hello" : "world"
},
"createdBy" : "d394beb0-880a-4a68-9ea3-2bc6981bccbf",
"createdAt" : {
"nano" : 862148000,
"epochSecond" : 1744903819
},
"updatedAt" : {
"nano" : 862148000,
"epochSecond" : 1744903819
},
"deletedBy" : null,
"deletedAt" : null
}
Create Organization Preference
POST /organization-preferences
Request fields
Path | Type | Optional | Description |
---|---|---|---|
organizationId |
String |
true |
|
preferences |
Object |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "318f8815-c3bc-4f20-a14b-45310fc18202",
"preferences" : {
"first" : "my first preference."
}
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "756d3f06-d4af-4d34-b5c7-b282703653a0",
"organizationId" : "318f8815-c3bc-4f20-a14b-45310fc18202",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "7e19a565-3dbd-46a0-8bf3-9ad3df9a8512",
"createdAt" : {
"nano" : 789928000,
"epochSecond" : 1744903819
},
"updatedAt" : {
"nano" : 789928000,
"epochSecond" : 1744903819
},
"deletedBy" : null,
"deletedAt" : null
}
Update Organization Preference
PUT /organization-preferences/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
preferences |
Object |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences/76e80fba-2c9d-439f-96a5-70f6b541952d' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"preferences" : {
"updated" : "my second preference."
}
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 433
{
"id" : "76e80fba-2c9d-439f-96a5-70f6b541952d",
"organizationId" : "84b7c783-36e6-472b-808e-45056d7aa8d4",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "4e4ed31a-b470-44cb-8938-b0e27535bc00",
"createdAt" : {
"nano" : 979224000,
"epochSecond" : 1744903819
},
"updatedAt" : {
"nano" : 993701000,
"epochSecond" : 1744903819
},
"deletedBy" : null,
"deletedAt" : null
}
Delete Organization Preference
DELETE /organization-preferences/{id}
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences/a658d146-2508-4a2e-b123-a86a4f0781f9' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "a658d146-2508-4a2e-b123-a86a4f0781f9",
"organizationId" : "9c057089-8973-4f86-867e-f097a154b1f9",
"preferences" : {
"hello" : "world"
},
"createdBy" : "7090cb56-4a91-4b92-ae1a-883c1e1fed92",
"createdAt" : {
"nano" : 821925000,
"epochSecond" : 1744903819
},
"updatedAt" : {
"nano" : 831069000,
"epochSecond" : 1744903819
},
"deletedBy" : "1f4f3d74-d954-4f62-b5fb-11fa04a42a9e",
"deletedAt" : {
"nano" : 830000000,
"epochSecond" : 1744903819
}
}