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: 3202
[ {
"id" : "00ff945b-048e-458b-b097-a6a6530b3deb",
"name" : "World Wide Imports",
"label" : "WW-Imports-118",
"identityProviders" : [ {
"id" : "bed05bab-4edf-4f17-8d31-5d9670143296",
"organizationId" : "00ff945b-048e-458b-b097-a6a6530b3deb",
"auth0ConnectionId" : "auth0-opaque-connectionId-119",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 772627000,
"epochSecond" : 1752530257
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 770585000,
"epochSecond" : 1752530257
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "01b01c8c-4180-41d9-a359-2d6cf7f1ebe7",
"name" : "World Wide Imports",
"label" : "WW-Imports-33",
"identityProviders" : [ {
"id" : "d63345ae-7508-4ab7-ad07-808282815a6b",
"organizationId" : "01b01c8c-4180-41d9-a359-2d6cf7f1ebe7",
"auth0ConnectionId" : "auth0-opaque-connectionId-34",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 244439000,
"epochSecond" : 1752530255
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "51391bcd-db63-4078-b0cd-9aac0e9ef090",
"organizationId" : "01b01c8c-4180-41d9-a359-2d6cf7f1ebe7",
"name" : "Default Standard Role-42",
"roleType" : "Standard",
"roleId" : "7d072cad-fcdb-4e71-8c5e-5bcd6c7b9681",
"createdBy" : "7641e9e6-f0c4-4fc2-a69b-b7843ff958ec",
"createdAt" : {
"nano" : 276405000,
"epochSecond" : 1752530255
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 237705000,
"epochSecond" : 1752530255
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "4a4b9923-5943-4c4d-8e27-d6dd4583ca42",
"name" : "World Wide Imports",
"label" : "WW-Imports-63",
"identityProviders" : [ {
"id" : "2b404784-8401-444d-a0ca-81ac02d76307",
"organizationId" : "4a4b9923-5943-4c4d-8e27-d6dd4583ca42",
"auth0ConnectionId" : "auth0-opaque-connectionId-64",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 921179000,
"epochSecond" : 1752530255
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "3a38470c-4163-4fee-8dbb-17973896c5c2",
"organizationId" : "4a4b9923-5943-4c4d-8e27-d6dd4583ca42",
"name" : "Default Standard Role-70",
"roleType" : "Standard",
"roleId" : "cb74229d-bced-448b-a6e6-d92365449af5",
"createdBy" : "0da8493e-053c-4900-9ccc-7e0163f3797f",
"createdAt" : {
"nano" : 935330000,
"epochSecond" : 1752530255
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 918275000,
"epochSecond" : 1752530255
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
} ]
Get Organization By Self
GET /organizations/self
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/self' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2071
{
"id" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 678104000,
"epochSecond" : 1752530214
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "8565da39-f198-4f20-add5-db6f215e6b24",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 670048000,
"epochSecond" : 1752530214
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "54f9489f-84f6-40e1-babc-6c3f6536121a",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "2af9b195-822a-4639-ac55-455ea9c5f5ef",
"createdBy" : "7615bbab-2f5f-4cab-9a37-96917752d062",
"createdAt" : {
"nano" : 834300000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "30865e63-ab12-4f81-a105-f7edccd16f04",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "317176cc-6a59-4ee9-8349-960ff5637e1d",
"createdBy" : "5923c685-44f9-416d-aaa8-501a28dd4d9d",
"createdAt" : {
"nano" : 824321000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 613990000,
"epochSecond" : 1752530214
},
"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/86495db2-2f1f-4573-8fba-bde8b0f6a804' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2071
{
"id" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 678104000,
"epochSecond" : 1752530214
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "8565da39-f198-4f20-add5-db6f215e6b24",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 670048000,
"epochSecond" : 1752530214
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "54f9489f-84f6-40e1-babc-6c3f6536121a",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "2af9b195-822a-4639-ac55-455ea9c5f5ef",
"createdBy" : "7615bbab-2f5f-4cab-9a37-96917752d062",
"createdAt" : {
"nano" : 834300000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "30865e63-ab12-4f81-a105-f7edccd16f04",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "317176cc-6a59-4ee9-8349-960ff5637e1d",
"createdBy" : "5923c685-44f9-416d-aaa8-501a28dd4d9d",
"createdAt" : {
"nano" : 824321000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 613990000,
"epochSecond" : 1752530214
},
"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" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 678104000,
"epochSecond" : 1752530214
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "8565da39-f198-4f20-add5-db6f215e6b24",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 670048000,
"epochSecond" : 1752530214
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "54f9489f-84f6-40e1-babc-6c3f6536121a",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "2af9b195-822a-4639-ac55-455ea9c5f5ef",
"createdBy" : "7615bbab-2f5f-4cab-9a37-96917752d062",
"createdAt" : {
"nano" : 834300000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "30865e63-ab12-4f81-a105-f7edccd16f04",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "317176cc-6a59-4ee9-8349-960ff5637e1d",
"createdBy" : "5923c685-44f9-416d-aaa8-501a28dd4d9d",
"createdAt" : {
"nano" : 824321000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 613990000,
"epochSecond" : 1752530214
},
"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" : "1debdf59-7262-4adc-9b29-2dc5a5443614",
"name" : "Best Corp.",
"label" : "BEST-CORP",
"identityProviders" : [ {
"id" : "7c2a0dc1-dbfd-48ad-ab50-73e5ea82eea7",
"organizationId" : "1debdf59-7262-4adc-9b29-2dc5a5443614",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Best Corp.",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 523936000,
"epochSecond" : 1752530263
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 523026000,
"epochSecond" : 1752530263
},
"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/28753c58-0acf-422f-b08a-edabc1630034/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 817
{
"id" : "28753c58-0acf-422f-b08a-edabc1630034",
"name" : "World Wide Imports",
"label" : "WW-Imports-248",
"identityProviders" : [ {
"id" : "f647e60e-31ac-4ee1-b33d-b73df2d020fa",
"organizationId" : "28753c58-0acf-422f-b08a-edabc1630034",
"auth0ConnectionId" : "auth0-opaque-connectionId-249",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 221963000,
"epochSecond" : 1752530264
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : false,
"mfaProvider" : null,
"createdAt" : {
"nano" : 219257000,
"epochSecond" : 1752530264
},
"updatedAt" : {
"nano" : 239340000,
"epochSecond" : 1752530264
},
"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/933a46e4-f872-46ce-9bc7-659306ecf4dc/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: 1154
{
"id" : "933a46e4-f872-46ce-9bc7-659306ecf4dc",
"name" : "World Wide Imports",
"label" : "WW-Imports-244",
"identityProviders" : [ {
"id" : "12e3ce05-b1c6-411c-b278-536a39517d29",
"organizationId" : "933a46e4-f872-46ce-9bc7-659306ecf4dc",
"auth0ConnectionId" : "auth0-opaque-connectionId-245",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 983388000,
"epochSecond" : 1752530263
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "f1074279-200e-444d-bc71-f70e00c7b01d",
"organizationId" : "933a46e4-f872-46ce-9bc7-659306ecf4dc",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 8908000,
"epochSecond" : 1752530264
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 981683000,
"epochSecond" : 1752530263
},
"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" : "10c007b5-3f17-4b84-8b3e-36a68f69b59a",
"issuer" : "https://e7e4de5b-72c0-456f-a04a-435457125351.issuer.idp",
"jwksUri" : "https://e7e4de5b-72c0-456f-a04a-435457125351.issuer.idp/jwks",
"active" : true,
"createdBy" : "52faeb4c-979c-4ee2-9fe3-12c3c8702acf",
"createdAt" : {
"nano" : 631244000,
"epochSecond" : 1752530261
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "42a6e9cd-9803-4eac-b949-5c8d8e9e524b",
"issuer" : "https://dc587585-3238-4a32-96e4-5917e4cc208c.issuer.idp",
"jwksUri" : "https://dc587585-3238-4a32-96e4-5917e4cc208c.issuer.idp/jwks",
"active" : true,
"createdBy" : "e648e2e4-9bf3-4fc2-8505-21fe0e069f02",
"createdAt" : {
"nano" : 968164000,
"epochSecond" : 1752530261
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "43e01b5d-3349-48a2-ad3f-11a50d16c004",
"issuer" : "https://b0078b1e-2bc9-464b-bd6d-847459816d28.issuer.idp",
"jwksUri" : "https://b0078b1e-2bc9-464b-bd6d-847459816d28.issuer.idp/jwks",
"active" : true,
"createdBy" : "ea86440d-5629-40d4-94e6-8f2fb3935b60",
"createdAt" : {
"nano" : 747997000,
"epochSecond" : 1752530261
},
"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/4e86129f-ad3d-43a1-84ce-47c7a1abd29c' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 419
{
"id" : "4e86129f-ad3d-43a1-84ce-47c7a1abd29c",
"issuer" : "https://a87d87ea-8000-4e02-8323-7db74eb4bdd5.issuer.idp",
"jwksUri" : "https://a87d87ea-8000-4e02-8323-7db74eb4bdd5.issuer.idp/jwks",
"active" : true,
"createdBy" : "8b79cce0-10e5-48e3-9e27-4e4748f1ddd2",
"createdAt" : {
"nano" : 537840000,
"epochSecond" : 1752530262
},
"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://a503323c-e572-49ab-91a2-5e7e4e21487f.issuer.idp",
"jwksUri" : "https://a503323c-e572-49ab-91a2-5e7e4e21487f.issuer.idp/jwks",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 419
{
"id" : "3014c101-9d85-4c88-b74b-92a88d19f884",
"issuer" : "https://a503323c-e572-49ab-91a2-5e7e4e21487f.issuer.idp",
"jwksUri" : "https://a503323c-e572-49ab-91a2-5e7e4e21487f.issuer.idp/jwks",
"active" : true,
"createdBy" : "5669f3c4-48f2-4e4a-b18c-94f6ea204717",
"createdAt" : {
"nano" : 494079000,
"epochSecond" : 1752530262
},
"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/7b4bcf98-4bab-4fbb-8756-0838015cde18' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"issuer" : "https://57e416a3-e012-4a09-ac5d-b8f199cfaa34.issuer.idp",
"jwksUri" : "https://57e416a3-e012-4a09-ac5d-b8f199cfaa34.issuer.idp/jwks",
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
{
"id" : "7b4bcf98-4bab-4fbb-8756-0838015cde18",
"issuer" : "https://57e416a3-e012-4a09-ac5d-b8f199cfaa34.issuer.idp",
"jwksUri" : "https://57e416a3-e012-4a09-ac5d-b8f199cfaa34.issuer.idp/jwks",
"active" : false,
"createdBy" : "885e0560-8164-4203-8f35-bc914c53b448",
"createdAt" : {
"nano" : 422616000,
"epochSecond" : 1752530262
},
"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/ca07c9d6-396c-4484-8984-07112f81b439' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "ca07c9d6-396c-4484-8984-07112f81b439",
"issuer" : "https://81006355-9d63-46ef-834b-168e1d04c189.issuer.idp",
"jwksUri" : "https://81006355-9d63-46ef-834b-168e1d04c189.issuer.idp/jwks",
"active" : true,
"createdBy" : "cf734ee5-cf89-4645-aeb7-a3412608ada2",
"createdAt" : {
"nano" : 592756000,
"epochSecond" : 1752530262
},
"deletedAt" : {
"nano" : 600808000,
"epochSecond" : 1752530262
},
"deletedBy" : "62c9a0ac-460a-40b1-b3fe-a363214cfebf",
"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: 2070
[ {
"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" : 300058000,
"epochSecond" : 1752530211
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "798ce9f4-5df0-4fd1-ac8d-a60da465f1fd",
"oidcIssuerId" : "5efab8f3-e709-49f3-89a7-e199daa04cfc",
"clientId" : "clientId-b3a97c56-1271-418c-9398-33bde24a52c9",
"clientSecret" : "clientSecret-c2c7542e-df01-47bd-ad78-6f68e3351e45",
"authorizationEndpoint" : "https://b3a1dec9-59b6-4155-a784-b19d2135ab73.issuer.idp/authorize",
"tokenEndpoint" : "https://b3a1dec9-59b6-4155-a784-b19d2135ab73.issuer.idp/token",
"userInfoEndpoint" : "https://b3a1dec9-59b6-4155-a784-b19d2135ab73.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "17834426-44b9-410d-b119-0d0bb6f0ca3c",
"createdAt" : {
"nano" : 719606000,
"epochSecond" : 1752530262
},
"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" : 300058000,
"epochSecond" : 1752530211
},
"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/d554ca4a-ca00-423a-840b-4982899be30e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776
{
"id" : "d554ca4a-ca00-423a-840b-4982899be30e",
"oidcIssuerId" : "c6079463-42c2-403d-9c3b-8e059f829deb",
"clientId" : "clientId-17f2555c-d16a-4907-96ac-a39d34bb3b46",
"clientSecret" : "clientSecret-4e84296b-c61a-4739-b809-fbdff192b6ca",
"authorizationEndpoint" : "https://54c7b24e-1b31-4460-9337-4f96fcf30f43.issuer.idp/authorize",
"tokenEndpoint" : "https://54c7b24e-1b31-4460-9337-4f96fcf30f43.issuer.idp/token",
"userInfoEndpoint" : "https://54c7b24e-1b31-4460-9337-4f96fcf30f43.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "6adc966c-bc96-4be3-85c0-4e2469309fc0",
"createdAt" : {
"nano" : 154997000,
"epochSecond" : 1752530263
},
"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" : "158f18e0-4639-4dc3-b18b-e459033d0f89",
"clientId" : "clientId-529aba16-2f28-4bdf-a716-e02cc974a49b",
"clientSecret" : "clientSecret-14a8a2d9-49d8-4c63-afdc-0116a957109c",
"authorizationEndpoint" : "https://a9fdbc30-6d7d-4d74-ab9d-a66996b28305.issuer.idp/authorize",
"tokenEndpoint" : "https://a9fdbc30-6d7d-4d74-ab9d-a66996b28305.issuer.idp/token",
"userInfoEndpoint" : "https://a9fdbc30-6d7d-4d74-ab9d-a66996b28305.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 776
{
"id" : "4ac8bbdc-7c31-4d49-95cc-2b47d3ecccae",
"oidcIssuerId" : "158f18e0-4639-4dc3-b18b-e459033d0f89",
"clientId" : "clientId-529aba16-2f28-4bdf-a716-e02cc974a49b",
"clientSecret" : "clientSecret-14a8a2d9-49d8-4c63-afdc-0116a957109c",
"authorizationEndpoint" : "https://a9fdbc30-6d7d-4d74-ab9d-a66996b28305.issuer.idp/authorize",
"tokenEndpoint" : "https://a9fdbc30-6d7d-4d74-ab9d-a66996b28305.issuer.idp/token",
"userInfoEndpoint" : "https://a9fdbc30-6d7d-4d74-ab9d-a66996b28305.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "69e62821-9bb3-4f2c-8205-bafd520c0ebc",
"createdAt" : {
"nano" : 108460000,
"epochSecond" : 1752530263
},
"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/cfdfb7e3-f755-4203-8909-002a10a79cfc' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"clientId" : "clientId-63daacda-fafb-453d-ae30-6c79be04d6e1",
"clientSecret" : "clientSecret-165febd3-7fbc-451d-bfc8-9ac36a836f0b",
"authorizationEndpoint" : "https://33cdcf91-8497-4def-9109-fd1026d0a0fb.issuer.idp/authorize",
"tokenEndpoint" : "https://33cdcf91-8497-4def-9109-fd1026d0a0fb.issuer.idp/token",
"userInfoEndpoint" : "https://33cdcf91-8497-4def-9109-fd1026d0a0fb.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776
{
"id" : "cfdfb7e3-f755-4203-8909-002a10a79cfc",
"oidcIssuerId" : "b800ee2b-4831-43bd-87a3-579982e6b13e",
"clientId" : "clientId-63daacda-fafb-453d-ae30-6c79be04d6e1",
"clientSecret" : "clientSecret-165febd3-7fbc-451d-bfc8-9ac36a836f0b",
"authorizationEndpoint" : "https://33cdcf91-8497-4def-9109-fd1026d0a0fb.issuer.idp/authorize",
"tokenEndpoint" : "https://33cdcf91-8497-4def-9109-fd1026d0a0fb.issuer.idp/token",
"userInfoEndpoint" : "https://33cdcf91-8497-4def-9109-fd1026d0a0fb.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "19d5d935-b3c3-4943-8911-6dfa655886a3",
"createdAt" : {
"nano" : 31041000,
"epochSecond" : 1752530263
},
"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/21f53773-989b-4b34-acc0-4b8d4feb6f2e' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 865
{
"id" : "21f53773-989b-4b34-acc0-4b8d4feb6f2e",
"oidcIssuerId" : "e0299edf-3899-4a31-ad99-21361ca4ed83",
"clientId" : "clientId-995f19aa-363c-4563-ab9a-12379776a7c6",
"clientSecret" : "clientSecret-4f9646ba-48d4-469e-a6e5-679c8da331ca",
"authorizationEndpoint" : "https://86a3ec7c-4ac0-496b-9d7f-b9b7b36debbe.issuer.idp/authorize",
"tokenEndpoint" : "https://86a3ec7c-4ac0-496b-9d7f-b9b7b36debbe.issuer.idp/token",
"userInfoEndpoint" : "https://86a3ec7c-4ac0-496b-9d7f-b9b7b36debbe.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "17c4cd8f-fd01-41b5-8a35-29c57a2fec2a",
"createdAt" : {
"nano" : 215006000,
"epochSecond" : 1752530263
},
"deletedAt" : {
"nano" : 230677000,
"epochSecond" : 1752530263
},
"deletedBy" : "7aefce4e-4ecc-4e25-8210-98da6d234a52",
"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: 1499
[ {
"id" : "316943f2-0c28-4360-9554-5d732a7c751e",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "ACME Federated Active Directory",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "99da7791-e9a5-42f8-8e7b-4238e8dcbdcf",
"createdAt" : {
"nano" : 761525000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "6fda770e-94f3-4e61-8af8-66bed339510a",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"oidcPublicClientId" : "f4e6fcd0-1839-4566-8828-856e42b8f156",
"name" : "Google-Account",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "3c83a985-0d9e-4b51-b3fb-fd996560650b",
"createdAt" : {
"nano" : 818359000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "8aa4d344-3b83-46e6-a6ab-2b9a9e0f206d",
"organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "NetFoundry Google Account",
"active" : true,
"customQueryParameters" : "{\"audience\": \"https://gateway.{env}.netfoundry.io/\", \"connection\": \"google-oauth2\"}",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 998040000,
"epochSecond" : 1752530210
},
"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/ef3d7cf4-48d2-4cb7-a393-81677cdf8607' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 495
{
"id" : "ef3d7cf4-48d2-4cb7-a393-81677cdf8607",
"organizationId" : "8e58ef6e-9152-4d8f-b24f-72e3e2bb8ff5",
"oidcPublicClientId" : "144cde7c-bc83-4451-9207-f9e47a6bb6af",
"name" : "console-client-c14a4daa-5ef1-4d73-ab66-942c6376c8cf",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "883fe0d6-4053-4b8b-83da-647e44f3204c",
"createdAt" : {
"nano" : 819216000,
"epochSecond" : 1752530264
},
"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 |
|
customQueryParameters |
String |
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" : "559f51c1-a27a-4481-bc2f-be97e821e1e0",
"oidcPublicClientId" : "c42bf879-6f3d-4746-8b55-baca27ae8cc0",
"name" : "console-client-946f1174-f0a9-4b00-9b09-423d60da4940",
"active" : true,
"customQueryParameters" : "{}"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 495
{
"id" : "cd3e5328-4136-4812-9546-55fef588ad60",
"organizationId" : "559f51c1-a27a-4481-bc2f-be97e821e1e0",
"oidcPublicClientId" : "c42bf879-6f3d-4746-8b55-baca27ae8cc0",
"name" : "console-client-946f1174-f0a9-4b00-9b09-423d60da4940",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "1abd73fc-fcbb-4f4d-8980-d984b0f00641",
"createdAt" : {
"nano" : 777609000,
"epochSecond" : 1752530264
},
"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 |
|
customQueryParameters |
String |
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/7ec0d497-03ef-4b01-8efa-f339f9d89981' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"name" : "custom-client-0e891b89-c2fb-4106-9f3b-c1e16fb08c81",
"active" : true,
"customQueryParameters" : "{}"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 494
{
"id" : "7ec0d497-03ef-4b01-8efa-f339f9d89981",
"organizationId" : "eb3786ac-c7f3-452e-91c7-9e07889dafaf",
"oidcPublicClientId" : "dde2cea0-aac9-4fa6-b8d3-9cda21cde13c",
"name" : "custom-client-0e891b89-c2fb-4106-9f3b-c1e16fb08c81",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "2795a5c5-7da7-4708-8528-3e611734b757",
"createdAt" : {
"nano" : 713684000,
"epochSecond" : 1752530264
},
"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/bfb317e1-f8a4-4bf9-b284-c8a83a67b851' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 543
{
"id" : "bfb317e1-f8a4-4bf9-b284-c8a83a67b851",
"organizationId" : "52ec06d2-502b-463d-861b-43e85fc0b095",
"oidcPublicClientId" : "1c8ee324-890e-4ade-ab0d-e3bd4c4e9e7d",
"name" : "number two",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "ef5273cd-43ad-40e7-824a-52fb8107e75b",
"createdAt" : {
"nano" : 896876000,
"epochSecond" : 1752530264
},
"deletedAt" : {
"nano" : 907673000,
"epochSecond" : 1752530264
},
"deletedBy" : "d02257ba-4205-47a0-932b-fdde348c87fd",
"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: 1282
[ {
"id" : "533d115e-302e-4f84-a6db-2dca7837e266",
"oidcIssuerId" : "82979bff-7d05-4794-946e-b350d4595b5d",
"audience" : "mop-aud-2d465c8d-d717-4519-898e-f6bed3179999",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "b4304a82-766e-4488-a19d-ed6c2af3387b",
"createdAt" : {
"nano" : 384786000,
"epochSecond" : 1752530261
},
"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" : 307394000,
"epochSecond" : 1752530211
},
"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" : 307394000,
"epochSecond" : 1752530211
},
"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/c533f99c-eebe-48b4-934d-ba1f8e6ff866' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430
{
"id" : "c533f99c-eebe-48b4-934d-ba1f8e6ff866",
"oidcIssuerId" : "62b54786-b5be-43b4-8b80-c3e233da2793",
"audience" : "mop-aud-48b3d200-9833-4211-aabe-c491e02be287",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "864135ea-65b8-4414-99db-0d3eda28d7aa",
"createdAt" : {
"nano" : 907445000,
"epochSecond" : 1752530261
},
"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" : "b2b69975-ffcd-4433-b3d8-cdcac500fcc7",
"audience" : "mop-aud-54807c3a-133f-4d33-86f6-6ac22bf108bb",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "40daf4ea-405d-49f6-9075-e39859749a6f",
"oidcIssuerId" : "b2b69975-ffcd-4433-b3d8-cdcac500fcc7",
"audience" : "mop-aud-54807c3a-133f-4d33-86f6-6ac22bf108bb",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "24352e82-bed3-487e-b06f-d48b9cff4497",
"createdAt" : {
"nano" : 860004000,
"epochSecond" : 1752530261
},
"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/8968922c-fd12-4217-8328-05ceb46f4b28' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"audience" : "mop-aud-0fe14c65-4ede-409e-a7d8-ff4f8bc03e4e",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "8968922c-fd12-4217-8328-05ceb46f4b28",
"oidcIssuerId" : "43e01b5d-3349-48a2-ad3f-11a50d16c004",
"audience" : "mop-aud-0fe14c65-4ede-409e-a7d8-ff4f8bc03e4e",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "7da85b68-30b8-4577-90cb-e30620e3a846",
"createdAt" : {
"nano" : 751653000,
"epochSecond" : 1752530261
},
"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/9b452db5-14b1-4a4b-8007-17201700f338' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 519
{
"id" : "9b452db5-14b1-4a4b-8007-17201700f338",
"oidcIssuerId" : "42a6e9cd-9803-4eac-b949-5c8d8e9e524b",
"audience" : "mop-aud-1906d73f-0246-4aa7-914f-727d4d3ebfbd",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "4b38898b-fca0-42f9-90a1-28c53ac952b8",
"createdAt" : {
"nano" : 973798000,
"epochSecond" : 1752530261
},
"deletedAt" : {
"nano" : 994309000,
"epochSecond" : 1752530261
},
"deletedBy" : "61fbd3c2-db45-4a4b-b632-c030bbeb4bf1",
"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/2d716621-dbf9-45c3-9850-707ef69b381d' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 460
{
"id" : "2d716621-dbf9-45c3-9850-707ef69b381d",
"userIdentityId" : "ab813001-1fe2-4167-ab45-d87cf93a95f4",
"oidcAudienceId" : "0aa5e413-620c-4929-ae12-9a45fcce8bfa",
"subject" : "console-client-9a7949ce-73c0-4855-bc0a-6b7cc07a24f6",
"active" : true,
"createdBy" : "14f54b81-2f72-4c76-8a19-b9299638f461",
"createdAt" : {
"nano" : 578637000,
"epochSecond" : 1752530267
},
"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" : "e6658c6e-7c13-4b4a-8b58-cc638d3bb605",
"oidcAudienceId" : "f374f21f-8070-42e2-80cb-3fd0d72294d7",
"subject" : "console-client-f5d93ed1-4eb9-4303-85c2-7214ec7e148d",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 460
{
"id" : "e5aed450-2ba3-4c93-ac90-202f8bf19ecb",
"userIdentityId" : "e6658c6e-7c13-4b4a-8b58-cc638d3bb605",
"oidcAudienceId" : "f374f21f-8070-42e2-80cb-3fd0d72294d7",
"subject" : "console-client-f5d93ed1-4eb9-4303-85c2-7214ec7e148d",
"active" : true,
"createdBy" : "95389ffe-29b2-4e17-8580-e8fa6ea29430",
"createdAt" : {
"nano" : 538935000,
"epochSecond" : 1752530267
},
"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/c34b407d-75f9-4236-a66f-ed5869d7b1b6' -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" : "c34b407d-75f9-4236-a66f-ed5869d7b1b6",
"userIdentityId" : "3dcff0ef-7f3f-423a-b7fe-e8660dac1837",
"oidcAudienceId" : "17f13766-20a2-4057-84c1-ae39ffd836b9",
"subject" : "console-client-0d3a607a-064c-4064-a395-4ee7a0f0f927",
"active" : false,
"createdBy" : "51b875db-5f0a-422c-b864-c39a9626e951",
"createdAt" : {
"nano" : 471463000,
"epochSecond" : 1752530267
},
"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/92a87265-4d4e-4ab5-8fac-aa60957de9fb' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 549
{
"id" : "92a87265-4d4e-4ab5-8fac-aa60957de9fb",
"userIdentityId" : "9b917e5a-1db4-4628-b5ed-cbb51c8c23f2",
"oidcAudienceId" : "5912a4e7-1004-4d82-ae03-5881c98715e5",
"subject" : "console-client-10e01f58-506d-41bf-846a-97d0210fc203",
"active" : true,
"createdBy" : "28f15d25-8b92-40de-ad29-75f27bc4075b",
"createdAt" : {
"nano" : 625804000,
"epochSecond" : 1752530267
},
"deletedAt" : {
"nano" : 635020000,
"epochSecond" : 1752530267
},
"deletedBy" : "feca51e6-d4ec-4280-a41a-6c9837d8a259",
"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: 1139
[ {
"id" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 678104000,
"epochSecond" : 1752530214
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "2b404784-8401-444d-a0ca-81ac02d76307",
"organizationId" : "4a4b9923-5943-4c4d-8e27-d6dd4583ca42",
"auth0ConnectionId" : "auth0-opaque-connectionId-64",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 921179000,
"epochSecond" : 1752530255
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "5cea67be-fc29-48ed-9dfe-5d2475fa5d90",
"organizationId" : "99032ca6-eb9f-4a96-8b0b-67b65c6d6a00",
"auth0ConnectionId" : "auth0-opaque-connectionId-72",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 987486000,
"epochSecond" : 1752530255
},
"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/0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 373
{
"id" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 678104000,
"epochSecond" : 1752530214
},
"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" : "918b5db7-a72a-4699-a91a-4ce556d8ed7e",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 368
{
"id" : "c283951b-342c-4049-a6e7-d8010cbdeac1",
"organizationId" : "918b5db7-a72a-4699-a91a-4ce556d8ed7e",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 566436000,
"epochSecond" : 1752530259
},
"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/e0f1f7d4-596d-42fb-87db-57b4db4cf716' -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: 429
{
"id" : "e0f1f7d4-596d-42fb-87db-57b4db4cf716",
"organizationId" : "eac7afbe-df48-432c-a37e-12e2759d1e99",
"auth0ConnectionId" : "auth0-opaque-connectionId-209",
"name" : "New IdP Name",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 81535000,
"epochSecond" : 1752530260
},
"updatedAt" : {
"nano" : 96996000,
"epochSecond" : 1752530260
},
"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/632b72ae-9741-4ac9-ac9a-c04577fa9d77/activate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "632b72ae-9741-4ac9-ac9a-c04577fa9d77",
"organizationId" : "6aa31346-ff67-4320-a2a5-9145eee01969",
"auth0ConnectionId" : "auth0-opaque-connectionId-203",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 713365000,
"epochSecond" : 1752530259
},
"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/1984cf63-9324-4766-8891-c1279f72663e' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 489
{
"id" : "1984cf63-9324-4766-8891-c1279f72663e",
"organizationId" : "b8312333-60da-4879-b32d-18afcf9f779c",
"auth0ConnectionId" : "auth0-opaque-connectionId-207",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 37796000,
"epochSecond" : 1752530260
},
"updatedAt" : {
"nano" : 50448000,
"epochSecond" : 1752530260
},
"deletedAt" : {
"nano" : 49000000,
"epochSecond" : 1752530260
}
}
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: 1277
[ {
"id" : "30865e63-ab12-4f81-a105-f7edccd16f04",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "317176cc-6a59-4ee9-8349-960ff5637e1d",
"createdBy" : "5923c685-44f9-416d-aaa8-501a28dd4d9d",
"createdAt" : {
"nano" : 824321000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "51391bcd-db63-4078-b0cd-9aac0e9ef090",
"organizationId" : "01b01c8c-4180-41d9-a359-2d6cf7f1ebe7",
"name" : "Default Standard Role-42",
"roleType" : "Standard",
"roleId" : "7d072cad-fcdb-4e71-8c5e-5bcd6c7b9681",
"createdBy" : "7641e9e6-f0c4-4fc2-a69b-b7843ff958ec",
"createdAt" : {
"nano" : 276405000,
"epochSecond" : 1752530255
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "54f9489f-84f6-40e1-babc-6c3f6536121a",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "2af9b195-822a-4639-ac55-455ea9c5f5ef",
"createdBy" : "7615bbab-2f5f-4cab-9a37-96917752d062",
"createdAt" : {
"nano" : 834300000,
"epochSecond" : 1752530214
},
"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/54f9489f-84f6-40e1-babc-6c3f6536121a' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
{
"id" : "54f9489f-84f6-40e1-babc-6c3f6536121a",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "2af9b195-822a-4639-ac55-455ea9c5f5ef",
"createdBy" : "7615bbab-2f5f-4cab-9a37-96917752d062",
"createdAt" : {
"nano" : 834300000,
"epochSecond" : 1752530214
},
"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" : "995420be-2216-473a-9db0-14422527a25d",
"roleType" : "Standard",
"roleId" : "6030eda7-b8ad-4aea-a94d-a378c7716ac7"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 458
{
"id" : "70187c04-3bb1-4df9-8f68-01f864bfe6ec",
"organizationId" : "995420be-2216-473a-9db0-14422527a25d",
"name" : "Standard Role - 6030eda7-b8ad-4aea-a94d-a378c7716ac7",
"roleType" : "Standard",
"roleId" : "6030eda7-b8ad-4aea-a94d-a378c7716ac7",
"createdBy" : "466b6a9a-ffdb-49b0-8fb7-c9b74a5b4928",
"createdAt" : {
"nano" : 856483000,
"epochSecond" : 1752530255
},
"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/f8aac1c6-da34-4aba-9681-cee5636255a2' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "f8aac1c6-da34-4aba-9681-cee5636255a2",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"name" : "Test Deletion",
"roleType" : "Standard",
"roleId" : "c985c4ae-96c1-4536-aa8f-67cc9a23ec12",
"createdBy" : "9cefb6fc-1de9-4d56-8607-b448c03421a4",
"createdAt" : {
"nano" : 617387000,
"epochSecond" : 1752530255
},
"deletedAt" : {
"nano" : 628000000,
"epochSecond" : 1752530255
},
"deletedBy" : "a9e61b4c-33a7-45ed-8798-8b7910b763bd",
"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/51391bcd-db63-4078-b0cd-9aac0e9ef090/grant' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"includeIdentityIds" : [ "a907268d-4d45-400b-9d89-2df2951507b2", "44ee8462-0d5d-46d4-b390-d79744937ff4", "d9ab2c8f-511c-4599-b315-18d53b4fc03c" ],
"excludeIdentityIds" : [ "d9ab2c8f-511c-4599-b315-18d53b4fc03c", "44ee8462-0d5d-46d4-b390-d79744937ff4", "6c955412-7c82-472c-bbd5-357d6a77a466" ]
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51
{
"a907268d-4d45-400b-9d89-2df2951507b2" : 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 |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
organizationId |
String |
true |
|
createdAt |
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" : "73171a99-5f68-422b-b3d4-ba0653a57779",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-305@acme.com",
"identityMappings" : [ {
"id" : "840d3156-881b-4c0d-a162-33360e0fb502",
"auth0UserId" : "auth0-opaque-userId-306",
"identityProviderId" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"userIdentityId" : "73171a99-5f68-422b-b3d4-ba0653a57779"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 329538000,
"epochSecond" : 1752530266
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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 |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
organizationId |
String |
true |
|
createdAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identities/3394b5d4-0aa9-45c9-81c7-698c456bf469' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "3394b5d4-0aa9-45c9-81c7-698c456bf469",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "76880a50-9b0f-4bcd-b979-309f9f9a313b",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "8565da39-f198-4f20-add5-db6f215e6b24",
"userIdentityId" : "3394b5d4-0aa9-45c9-81c7-698c456bf469"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 864792000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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: 2150
[ {
"id" : "2d2e8067-fecb-4b63-b737-5f372ab14351",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-95@acme.com",
"identityMappings" : [ {
"id" : "ddb5ef18-42fa-454a-b00e-c8d4144f61fd",
"auth0UserId" : "auth0-opaque-userId-96",
"identityProviderId" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"userIdentityId" : "2d2e8067-fecb-4b63-b737-5f372ab14351"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 143737000,
"epochSecond" : 1752530257
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"type" : "UserIdentity"
}, {
"id" : "3394b5d4-0aa9-45c9-81c7-698c456bf469",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "76880a50-9b0f-4bcd-b979-309f9f9a313b",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "8565da39-f198-4f20-add5-db6f215e6b24",
"userIdentityId" : "3394b5d4-0aa9-45c9-81c7-698c456bf469"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 864792000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"type" : "UserIdentity"
}, {
"id" : "4239e450-fb68-476f-9be4-3f2cebbf2a62",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-93@acme.com",
"identityMappings" : [ {
"id" : "f1923200-fc81-41e4-aef6-88cd0063f204",
"auth0UserId" : "auth0-opaque-userId-94",
"identityProviderId" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"userIdentityId" : "4239e450-fb68-476f-9be4-3f2cebbf2a62"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 138555000,
"epochSecond" : 1752530257
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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/3394b5d4-0aa9-45c9-81c7-698c456bf469' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "3394b5d4-0aa9-45c9-81c7-698c456bf469",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "76880a50-9b0f-4bcd-b979-309f9f9a313b",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "8565da39-f198-4f20-add5-db6f215e6b24",
"userIdentityId" : "3394b5d4-0aa9-45c9-81c7-698c456bf469"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 864792000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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/8565da39-f198-4f20-add5-db6f215e6b24' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "3394b5d4-0aa9-45c9-81c7-698c456bf469",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "76880a50-9b0f-4bcd-b979-309f9f9a313b",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "8565da39-f198-4f20-add5-db6f215e6b24",
"userIdentityId" : "3394b5d4-0aa9-45c9-81c7-698c456bf469"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 864792000,
"epochSecond" : 1752530214
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 478
{
"id" : "fc7ebf4c-4d5b-489d-b9e4-2cd3960b4ee8",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com",
"identityMappings" : [ ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 63970000,
"epochSecond" : 1752530267
},
"deletedAt" : null,
"name" : "Jane Doe",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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/acf0b63e-23fe-491b-939a-334a90797c80' -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" : "acf0b63e-23fe-491b-939a-334a90797c80",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com",
"identityMappings" : [ {
"id" : "a350d1dc-105a-4e1a-98c5-57e5567a2b24",
"auth0UserId" : "auth0-opaque-userId-310",
"identityProviderId" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"userIdentityId" : "acf0b63e-23fe-491b-939a-334a90797c80"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 499754000,
"epochSecond" : 1752530266
},
"deletedAt" : null,
"name" : "Bobby White",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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/19e27e73-0ba7-43e4-8c35-1f2dbcf40602/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 719
{
"id" : "19e27e73-0ba7-43e4-8c35-1f2dbcf40602",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-311@acme.com",
"identityMappings" : [ {
"id" : "ff853102-dac9-47a8-bbba-918f2f6e13b8",
"auth0UserId" : "auth0-opaque-userId-312",
"identityProviderId" : "0c3e4a8a-19e5-4bff-89dc-0c6ec5d45991",
"userIdentityId" : "19e27e73-0ba7-43e4-8c35-1f2dbcf40602"
} ],
"identityAudienceMappings" : [ ],
"active" : false,
"createdAt" : {
"nano" : 551526000,
"epochSecond" : 1752530266
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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/715b97d3-c294-493a-b62f-1547576d6d5f/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/db554b4e-5c9f-4a32-8a80-e3bb1282d15b/mapping' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"auth0UserId" : "new-auth0-userId:65ab180c-8f6c-406b-847d-5f213070c0f7",
"identityProviderId" : "8565da39-f198-4f20-add5-db6f215e6b24"
}'
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: 2091
[ {
"id" : "06a129a0-b408-4058-a472-2c5115ac78db",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ClientId" : null,
"awsCognitoClientId" : "2b55d56b-fde4-4414-837c-5a9cc9829518|iihyaysu",
"authenticationUrl" : "https://netfoundry-test-fgpxjw.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 415969000,
"epochSecond" : 1752530228
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"type" : "ApiAccountIdentity"
}, {
"id" : "12c80cd9-a1c8-4791-955f-ca024c2026db",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ClientId" : null,
"awsCognitoClientId" : "73b98517-6b37-449d-8062-52c1c71a084b|gxvuamum",
"authenticationUrl" : "https://netfoundry-test-ntcceu.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 967443000,
"epochSecond" : 1752530225
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"type" : "ApiAccountIdentity"
}, {
"id" : "166ae3b9-8776-44dc-9440-23fd15c27720",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ClientId" : null,
"awsCognitoClientId" : "f8c89c18-a83d-4e0e-96bf-6ac7cd3b2db0|eqbgkono",
"authenticationUrl" : "https://netfoundry-test-oomrjx.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Test Rotation",
"contactEmail" : "hr.director@acme.com",
"description" : "description goes here",
"active" : true,
"createdAt" : {
"nano" : 581318000,
"epochSecond" : 1752530219
},
"updatedAt" : {
"nano" : 607702000,
"epochSecond" : 1752530220
},
"deletedAt" : null,
"email" : "hr.director@acme.com",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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/68adde77-3b70-4c18-8b34-470df2823090' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 718
{
"id" : "68adde77-3b70-4c18-8b34-470df2823090",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ClientId" : "3db787ff-81f8-441d-9f0d-19f524a208c9",
"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" : 888421000,
"epochSecond" : 1752530214
},
"updatedAt" : {
"nano" : 742551000,
"epochSecond" : 1752530216
},
"deletedAt" : null,
"email" : "no-reply@acme.com",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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/0468b391-c4d6-4801-a11d-895e74a94d84' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 682
{
"id" : "06541984-3446-481a-96e8-c9fc20a1546b",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ClientId" : "0468b391-c4d6-4801-a11d-895e74a94d84",
"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" : 769131000,
"epochSecond" : 1752530254
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "service.admin-30@foo.com",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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" : "e3cbabab-9197-48ba-b5b4-e36cce32fa54",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ClientId" : null,
"awsCognitoClientId" : "f8c89c18-a83d-4e0e-96bf-6ac7cd3b2db0|hsxxemhf",
"authenticationUrl" : "https://netfoundry-test-oomrjx.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" : 971757000,
"epochSecond" : 1752530220
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "hr.director@acme.com",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"type" : "ApiAccountIdentity"
},
"clientId" : "hsxxemhf",
"password" : "pcquvhylbpblwgormqvvtmqw",
"authenticationUrl" : "https://netfoundry-test-oomrjx.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/9d836e64-c72b-4381-bb8a-9a0dbe4213e4' -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" : "9d836e64-c72b-4381-bb8a-9a0dbe4213e4",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ClientId" : "3f54a8aa-34ff-468f-85be-5fcf63a082c7",
"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" : 931465000,
"epochSecond" : 1752530214
},
"updatedAt" : {
"nano" : 714938000,
"epochSecond" : 1752530215
},
"deletedAt" : null,
"email" : "robot@acme.com",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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/f1648231-d8d3-4dea-85e2-39c0543e3ae1/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 739
{
"id" : "f1648231-d8d3-4dea-85e2-39c0543e3ae1",
"organizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"auth0ClientId" : "8ca6cc10-d4c3-4ce3-8fbd-f9d948cb6968",
"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" : 556845000,
"epochSecond" : 1752530254
},
"updatedAt" : {
"nano" : 593118000,
"epochSecond" : 1752530254
},
"deletedAt" : null,
"email" : "service.admin-24@foo.com",
"tenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"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" : "cb58bcf3-401f-46e0-acfa-99519e32ed21",
"fromIdentityId" : "8aaec876-df2e-4053-a2b0-691b1ddf2ac9",
"toOrganizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 254834000,
"epochSecond" : 1753135060
},
"targetUserIdentityId" : "5a7c0c87-071f-4c35-af62-80edf06e2869",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804"
} ]
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/b8fdcad0-a4a6-4ef5-8080-aa5cfd9939b7' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 527
{
"id" : "b8fdcad0-a4a6-4ef5-8080-aa5cfd9939b7",
"fromIdentityId" : "3394b5d4-0aa9-45c9-81c7-698c456bf469",
"toOrganizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"invitedEmailAddress" : "new.employee-219@acme.com",
"expiration" : {
"nano" : 698581000,
"epochSecond" : 1753135060
},
"targetUserIdentityId" : "310fad07-f4f0-4e36-9f23-48b4d545f12f",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804"
}
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" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"invitedEmailAddress" : "new.employee@acme.com",
"invitationUrl" : "http://acme.console.netfoundry.io/invitation",
"targetUserIdentityId" : "5a7c0c87-071f-4c35-af62-80edf06e2869",
"brandingOrganizationId" : null
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 523
{
"id" : "cb58bcf3-401f-46e0-acfa-99519e32ed21",
"fromIdentityId" : "8aaec876-df2e-4053-a2b0-691b1ddf2ac9",
"toOrganizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 254834000,
"epochSecond" : 1753135060
},
"targetUserIdentityId" : "5a7c0c87-071f-4c35-af62-80edf06e2869",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804"
}
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/f718645f-b073-4458-81dc-53ddabdaf66c/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 588
{
"id" : "f718645f-b073-4458-81dc-53ddabdaf66c",
"fromIdentityId" : "3394b5d4-0aa9-45c9-81c7-698c456bf469",
"toOrganizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"invitedEmailAddress" : "new.employee-216@acme.com",
"expiration" : {
"nano" : 620723000,
"epochSecond" : 1753135060
},
"targetUserIdentityId" : "83a27d4e-00ab-42f4-97b0-713399cbb874",
"accepted" : false,
"revokedAt" : null,
"responseReceivedAt" : {
"nano" : 645664000,
"epochSecond" : 1752530260
},
"state" : "Declined",
"toTenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804"
}
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/655fefd8-c54f-4c30-8a36-de41c44ad841/revoke' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 642
{
"id" : "655fefd8-c54f-4c30-8a36-de41c44ad841",
"fromIdentityId" : "3394b5d4-0aa9-45c9-81c7-698c456bf469",
"toOrganizationId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804",
"invitedEmailAddress" : "new.employee-222@acme.com",
"expiration" : {
"nano" : 758822000,
"epochSecond" : 1753135060
},
"targetUserIdentityId" : "cdb17d15-bf6c-4f85-a67d-8e569e8d5b1b",
"accepted" : null,
"revokedAt" : {
"nano" : 769617000,
"epochSecond" : 1752530260
},
"responseReceivedAt" : {
"nano" : 769620000,
"epochSecond" : 1752530260
},
"state" : "Revoked",
"toTenantId" : "86495db2-2f1f-4573-8fba-bde8b0f6a804"
}
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/3muBaQFfMNgsCD2KpWnkbNAqOIWlu8LSrpQq' -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" : 114412000,
"epochSecond" : 1753135061
},
"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/gIibcCHuL39l7zuxMI32UoU52InsiIXoDnwa/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" : 26791000,
"epochSecond" : 1753135061
},
"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/fQiVzDTCo4PrKIvBXQagjT70MyZeO2Wut0re/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.eyJpYXQiOjE3NTI1MzAyNjAsImV4cCI6MTc1MjUzMTE2MCwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJpbnZpdGF0aW9uIiwiaW52aXRhdGlvbklkIjoiMGUzNjAzMTctNTE2OC00YThkLTkyZDgtZmU5OGU1NmQxNGQ0IiwidGVuYW50TGFiZWwiOiJBQ01FLTAiLCJhdXRoMENvbm5lY3Rpb25JZHMiOlsiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0yIiwiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0xIl0sInJlZGlyZWN0VXJsIjoiaHR0cDovL2NvbnNvbGUubmZhZG1pbi5uZXRmb3VuZHJ5LmlvL2ludml0YXRpb24ifQ.G5vdC6sYK1vLwForGEygcQJ4nQKpNMrSDeiAzHF7Y6tlJhugFIHbz4rh2RSkraF6srSPFtupVPXTXZmTL5NynYxfT6G16EFF1UlWHNtSEMYD-BmZmjSd0t5cfUo24ILgxrJixu7gJg7OB96xSntcQOeFOV0yy1v7SHEjN-SNTmHe-p1ncugzf6SVuacHlpLqzUWrSTCm5e7-XP_pfaNRs6lG0UYP4yZ9AdoBof3QGRtM4q-zWZVbug9JU9uDis7-wMkVP33rK7ufygrqWmaYLCJ3PLRxPQxrYaPBO2LSUNCV9SpnlWTu7pJNJJf73B8xpRyk3nCqAtoDGa7CV6c9gg",
"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.eyJpYXQiOjE3NTI1MzAyNjEsImV4cCI6MTc1MjUzMTE2MSwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJsb2dpbiIsInRlbmFudExhYmVsIjoiQUNNRS0wIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMiIsImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMSJdLCJyZWRpcmVjdFVybCI6Imh0dHA6Ly9jb25zb2xlLm5mYWRtaW4ubmV0Zm91bmRyeS5pby9pbnZpdGF0aW9uIn0.t6YXwf0nApAPZyjlzstfh4W7SsHCKFKgnFuLxeUNdZBODtyQBFrzg-rwlB9Yrda6FmQWTg6bf9BD8YuPDIpUWb7FN3PaP65SSxpOuQu3B899Kb1Ng34wgC0CPtZjFjxfsxBTBrD3qaXzM71DDAJy4kYoVuz01S56womU1XZYSHODPT5izSom1JUTQbZWM_baQD-gMT_C8l0jFOQ-VJdb15-F6kUYhbj2YzzZ69sBHIrNQwtLfApNpW3JGCHpCyMOfl2-792AQv_1DFjtvmPi3LVUXPhJpyBWX8sHRNhPtrpN5EmogdOKkTVH5Dm6qTwi3mczWVTdxO-955vAMUk_vg",
"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: 1279
[ {
"id" : "799e1ba7-e975-4482-96c1-a3a7858e16dc",
"userIdentityId" : "7f97dcba-19f9-487d-a20d-be3afb2ccdc3",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "7f97dcba-19f9-487d-a20d-be3afb2ccdc3",
"createdAt" : {
"nano" : 97763000,
"epochSecond" : 1752530257
},
"updatedAt" : {
"nano" : 97763000,
"epochSecond" : 1752530257
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "876ad512-bf54-43c1-8009-431f3429b6df",
"userIdentityId" : "2d2e8067-fecb-4b63-b737-5f372ab14351",
"preferences" : {
"hello" : "world"
},
"createdBy" : "2d2e8067-fecb-4b63-b737-5f372ab14351",
"createdAt" : {
"nano" : 148352000,
"epochSecond" : 1752530257
},
"updatedAt" : {
"nano" : 148352000,
"epochSecond" : 1752530257
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "9ca0ecc1-1216-4834-8895-574d47bc2c29",
"userIdentityId" : "9d96c95d-3c22-4c44-a9ff-143f423eefda",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "9d96c95d-3c22-4c44-a9ff-143f423eefda",
"createdAt" : {
"nano" : 42473000,
"epochSecond" : 1752530257
},
"updatedAt" : {
"nano" : 42473000,
"epochSecond" : 1752530257
},
"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/0f51a0a9-af65-4acc-9bdd-757ef606d310' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "0f51a0a9-af65-4acc-9bdd-757ef606d310",
"userIdentityId" : "21f7bfb8-8669-44e2-b210-60e09c8091a5",
"preferences" : {
"hello" : "world"
},
"createdBy" : "21f7bfb8-8669-44e2-b210-60e09c8091a5",
"createdAt" : {
"nano" : 155234000,
"epochSecond" : 1752530258
},
"updatedAt" : {
"nano" : 155234000,
"epochSecond" : 1752530258
},
"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" : "1385fcd6-6b95-4f7e-bad7-d4a1490a6ab1",
"userIdentityId" : "431dac05-9de0-4268-8979-149bd76cf020",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "431dac05-9de0-4268-8979-149bd76cf020",
"createdAt" : {
"nano" : 524053000,
"epochSecond" : 1752530257
},
"updatedAt" : {
"nano" : 524053000,
"epochSecond" : 1752530257
},
"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/4620f65d-a549-4dbc-a05b-86df54fb73f9' -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: 431
{
"id" : "4620f65d-a549-4dbc-a05b-86df54fb73f9",
"userIdentityId" : "b67a6b4b-1161-46ab-af4b-e80033eec2de",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "b67a6b4b-1161-46ab-af4b-e80033eec2de",
"createdAt" : {
"nano" : 73691000,
"epochSecond" : 1752530259
},
"updatedAt" : {
"nano" : 84855000,
"epochSecond" : 1752530259
},
"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/0f5121e7-983c-4c88-ad34-efbad3966a7a' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "0f5121e7-983c-4c88-ad34-efbad3966a7a",
"userIdentityId" : "001eb219-960c-41da-84ae-d8e4d9dbd143",
"preferences" : {
"hello" : "world"
},
"createdBy" : "001eb219-960c-41da-84ae-d8e4d9dbd143",
"createdAt" : {
"nano" : 837663000,
"epochSecond" : 1752530257
},
"updatedAt" : {
"nano" : 849002000,
"epochSecond" : 1752530257
},
"deletedBy" : "62983cdb-90d9-4f13-a396-38bf17892ced",
"deletedAt" : {
"nano" : 848000000,
"epochSecond" : 1752530257
}
}
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" : "136f6147-635a-4940-ade0-94471a13bba3",
"organizationId" : "fcad14a7-4dc4-4c1a-b0d5-2a9770253015",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "3611dd6b-60c1-4771-9960-3dd698af63c8",
"createdAt" : {
"nano" : 282720000,
"epochSecond" : 1752530265
},
"updatedAt" : {
"nano" : 282720000,
"epochSecond" : 1752530265
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "27182388-9ec2-47fd-a02c-9f017400ce3e",
"organizationId" : "690f3630-9392-4cef-973b-5036a820c3bf",
"preferences" : {
"hello" : "world"
},
"createdBy" : "e932e10d-624d-4762-a4d0-d8e72e239cc2",
"createdAt" : {
"nano" : 199322000,
"epochSecond" : 1752530265
},
"updatedAt" : {
"nano" : 199322000,
"epochSecond" : 1752530265
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "8117a808-7dd8-44aa-b013-41dd6cea8d77",
"organizationId" : "849b2c7e-a598-427e-8c9b-68add6f8103e",
"preferences" : {
"hello" : "world"
},
"createdBy" : "aa402cff-51ce-44a7-ae0c-83eb04d8e68c",
"createdAt" : {
"nano" : 383185000,
"epochSecond" : 1752530265
},
"updatedAt" : {
"nano" : 383185000,
"epochSecond" : 1752530265
},
"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/8117a808-7dd8-44aa-b013-41dd6cea8d77' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "8117a808-7dd8-44aa-b013-41dd6cea8d77",
"organizationId" : "849b2c7e-a598-427e-8c9b-68add6f8103e",
"preferences" : {
"hello" : "world"
},
"createdBy" : "aa402cff-51ce-44a7-ae0c-83eb04d8e68c",
"createdAt" : {
"nano" : 383185000,
"epochSecond" : 1752530265
},
"updatedAt" : {
"nano" : 383185000,
"epochSecond" : 1752530265
},
"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" : "fcad14a7-4dc4-4c1a-b0d5-2a9770253015",
"preferences" : {
"first" : "my first preference."
}
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "136f6147-635a-4940-ade0-94471a13bba3",
"organizationId" : "fcad14a7-4dc4-4c1a-b0d5-2a9770253015",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "3611dd6b-60c1-4771-9960-3dd698af63c8",
"createdAt" : {
"nano" : 282720000,
"epochSecond" : 1752530265
},
"updatedAt" : {
"nano" : 282720000,
"epochSecond" : 1752530265
},
"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/26568b26-a553-4cfa-8a4c-dcc85503b306' -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" : "26568b26-a553-4cfa-8a4c-dcc85503b306",
"organizationId" : "6db93931-b73a-4c7a-b15f-7f2069438fff",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "6ed38177-70e0-403c-add8-8a45a162f435",
"createdAt" : {
"nano" : 544301000,
"epochSecond" : 1752530265
},
"updatedAt" : {
"nano" : 564388000,
"epochSecond" : 1752530265
},
"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/71d9c783-c168-4d42-a41c-653a021908d5' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "71d9c783-c168-4d42-a41c-653a021908d5",
"organizationId" : "dafa8679-c486-4f4a-b4f3-2183662d4249",
"preferences" : {
"hello" : "world"
},
"createdBy" : "86dff568-cc23-4ce5-9d6b-bca9de8037a6",
"createdAt" : {
"nano" : 325335000,
"epochSecond" : 1752530265
},
"updatedAt" : {
"nano" : 341296000,
"epochSecond" : 1752530265
},
"deletedBy" : "3a72841e-448a-4612-bc43-a0951838e778",
"deletedAt" : {
"nano" : 340000000,
"epochSecond" : 1752530265
}
}