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: 3227
[ {
"id" : "0e3c1ed0-38c5-4525-be5d-54c9fe4514b2",
"name" : "World Wide Imports",
"label" : "WW-Imports-61",
"identityProviders" : [ {
"id" : "23e1c0c9-4073-4ee3-9721-cf18c3ac176b",
"organizationId" : "0e3c1ed0-38c5-4525-be5d-54c9fe4514b2",
"auth0ConnectionId" : "auth0-opaque-connectionId-62",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 538616000,
"epochSecond" : 1746474595
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "ff9d3008-4443-4b32-9e2f-62efbb2b8bc2",
"organizationId" : "0e3c1ed0-38c5-4525-be5d-54c9fe4514b2",
"name" : "Standard Role - 83a50ad7-ed27-446f-8d0f-c15a55e3bf2d",
"roleType" : "Standard",
"roleId" : "83a50ad7-ed27-446f-8d0f-c15a55e3bf2d",
"createdBy" : "e755fb1b-f8d6-4792-8635-145149606e7d",
"createdAt" : {
"nano" : 571617000,
"epochSecond" : 1746474595
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 536904000,
"epochSecond" : 1746474595
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "3ca3613f-061b-4cdd-a159-6303c8e384a6",
"name" : "World Wide Imports",
"label" : "WW-Imports-33",
"identityProviders" : [ {
"id" : "b25cfe7d-884a-4108-b1b8-30750ec08e37",
"organizationId" : "3ca3613f-061b-4cdd-a159-6303c8e384a6",
"auth0ConnectionId" : "auth0-opaque-connectionId-34",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 56310000,
"epochSecond" : 1746474595
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "851dbade-d9fc-49f5-84b5-35776d04160b",
"organizationId" : "3ca3613f-061b-4cdd-a159-6303c8e384a6",
"name" : "Default Standard Role-42",
"roleType" : "Standard",
"roleId" : "942d5d7c-05c7-4bcc-a6ea-9ce441f42f9f",
"createdBy" : "1ecf6add-5cc8-47cf-a49c-ae0a7b418fd7",
"createdAt" : {
"nano" : 86200000,
"epochSecond" : 1746474595
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 54007000,
"epochSecond" : 1746474595
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "4203057a-1bb2-4b1b-ac41-82365baf923e",
"name" : "World Wide Imports",
"label" : "WW-Imports-115",
"identityProviders" : [ {
"id" : "88bcfbb3-8cc0-43f2-a865-c6b57ecb9d8c",
"organizationId" : "4203057a-1bb2-4b1b-ac41-82365baf923e",
"auth0ConnectionId" : "auth0-opaque-connectionId-116",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 426192000,
"epochSecond" : 1746474597
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 424624000,
"epochSecond" : 1746474597
},
"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" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 649205000,
"epochSecond" : 1746474554
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "670c506d-cca4-42c5-b152-9b3d9ae4844e",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 659374000,
"epochSecond" : 1746474554
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "5ce73c73-da92-4c09-ae5c-658b0b9f7865",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "13a6c96b-5847-43b0-a034-3583cfc5e6a5",
"createdBy" : "02dc4c12-999e-4517-8464-74fe9bdc3a3c",
"createdAt" : {
"nano" : 756443000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "740e8b32-63b0-4bce-814b-4424b2940fd4",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "873705a6-2ce8-4346-9202-2377dffa0adf",
"createdBy" : "a6665a07-f546-4c7f-af4d-0e6f9f3ad91a",
"createdAt" : {
"nano" : 765453000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 608807000,
"epochSecond" : 1746474554
},
"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/cdd47811-23ea-4357-9ada-01a0d40d4734' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2071
{
"id" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 649205000,
"epochSecond" : 1746474554
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "670c506d-cca4-42c5-b152-9b3d9ae4844e",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 659374000,
"epochSecond" : 1746474554
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "5ce73c73-da92-4c09-ae5c-658b0b9f7865",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "13a6c96b-5847-43b0-a034-3583cfc5e6a5",
"createdBy" : "02dc4c12-999e-4517-8464-74fe9bdc3a3c",
"createdAt" : {
"nano" : 756443000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "740e8b32-63b0-4bce-814b-4424b2940fd4",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "873705a6-2ce8-4346-9202-2377dffa0adf",
"createdBy" : "a6665a07-f546-4c7f-af4d-0e6f9f3ad91a",
"createdAt" : {
"nano" : 765453000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 608807000,
"epochSecond" : 1746474554
},
"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" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 649205000,
"epochSecond" : 1746474554
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "670c506d-cca4-42c5-b152-9b3d9ae4844e",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 659374000,
"epochSecond" : 1746474554
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "5ce73c73-da92-4c09-ae5c-658b0b9f7865",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "13a6c96b-5847-43b0-a034-3583cfc5e6a5",
"createdBy" : "02dc4c12-999e-4517-8464-74fe9bdc3a3c",
"createdAt" : {
"nano" : 756443000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "740e8b32-63b0-4bce-814b-4424b2940fd4",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "873705a6-2ce8-4346-9202-2377dffa0adf",
"createdBy" : "a6665a07-f546-4c7f-af4d-0e6f9f3ad91a",
"createdAt" : {
"nano" : 765453000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 608807000,
"epochSecond" : 1746474554
},
"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" : "587da906-fa93-4565-a2fa-5a93b7c17c70",
"name" : "Best Corp.",
"label" : "BEST-CORP",
"identityProviders" : [ {
"id" : "c13a8ba8-a549-49cd-bfe2-ba836666dc2f",
"organizationId" : "587da906-fa93-4565-a2fa-5a93b7c17c70",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Best Corp.",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 746230000,
"epochSecond" : 1746474602
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 745310000,
"epochSecond" : 1746474602
},
"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/25456b29-7860-4131-ba41-ad45b6caf4f1/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 817
{
"id" : "25456b29-7860-4131-ba41-ad45b6caf4f1",
"name" : "World Wide Imports",
"label" : "WW-Imports-248",
"identityProviders" : [ {
"id" : "e6f59512-e1ad-460e-9984-eeef18097004",
"organizationId" : "25456b29-7860-4131-ba41-ad45b6caf4f1",
"auth0ConnectionId" : "auth0-opaque-connectionId-249",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 283746000,
"epochSecond" : 1746474603
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : false,
"mfaProvider" : null,
"createdAt" : {
"nano" : 282596000,
"epochSecond" : 1746474603
},
"updatedAt" : {
"nano" : 303668000,
"epochSecond" : 1746474603
},
"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/b738f51c-c04e-41d5-8bae-3a63b889f862/identity-providers' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"auth0ConnectionId" : "auth0-opaque-connection",
"identityProviderName" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1156
{
"id" : "b738f51c-c04e-41d5-8bae-3a63b889f862",
"name" : "World Wide Imports",
"label" : "WW-Imports-244",
"identityProviders" : [ {
"id" : "3b1ab0ea-a861-44db-ba62-36eb4236447a",
"organizationId" : "b738f51c-c04e-41d5-8bae-3a63b889f862",
"auth0ConnectionId" : "auth0-opaque-connectionId-245",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 129440000,
"epochSecond" : 1746474603
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "9830d693-c378-4129-8743-c168d706a127",
"organizationId" : "b738f51c-c04e-41d5-8bae-3a63b889f862",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 146636000,
"epochSecond" : 1746474603
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 127998000,
"epochSecond" : 1746474603
},
"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" : "1ebbcfed-12d5-4fed-9eb0-7f81cb898067",
"issuer" : "https://0fba27c3-32d4-4bf7-a99b-511f2d259a2e.issuer.idp",
"jwksUri" : "https://0fba27c3-32d4-4bf7-a99b-511f2d259a2e.issuer.idp/jwks",
"active" : true,
"createdBy" : "989f9d28-b97b-47ce-a1b9-f4f60b362f9f",
"createdAt" : {
"nano" : 372487000,
"epochSecond" : 1746474601
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "24b0604e-0276-45e6-86d7-32537f0bfc81",
"issuer" : "https://825fa23f-c8a2-49f6-a3d7-1a63a2f4b8a4.issuer.idp",
"jwksUri" : "https://825fa23f-c8a2-49f6-a3d7-1a63a2f4b8a4.issuer.idp/jwks",
"active" : true,
"createdBy" : "bbe81ec4-3068-4b3d-b7f0-d566f83c64a1",
"createdAt" : {
"nano" : 280999000,
"epochSecond" : 1746474601
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "35e55a13-c4dd-4566-aa81-bf051e9c4f17",
"issuer" : "https://704b6db4-7e0f-45fa-a2fc-588eb829abab.issuer.idp",
"jwksUri" : "https://704b6db4-7e0f-45fa-a2fc-588eb829abab.issuer.idp/jwks",
"active" : true,
"createdBy" : "d7484c58-797d-474f-ab46-ba22c81711ea",
"createdAt" : {
"nano" : 956758000,
"epochSecond" : 1746474600
},
"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/b508849d-f837-4c1c-8566-0d6d75686414' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 419
{
"id" : "b508849d-f837-4c1c-8566-0d6d75686414",
"issuer" : "https://ed158aa0-fe2f-4a99-b9d7-c87704d7422b.issuer.idp",
"jwksUri" : "https://ed158aa0-fe2f-4a99-b9d7-c87704d7422b.issuer.idp/jwks",
"active" : true,
"createdBy" : "0b393a40-a842-4555-9a65-f85ef2071df7",
"createdAt" : {
"nano" : 842289000,
"epochSecond" : 1746474601
},
"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://a4cbe480-5263-4e03-ab7a-d60a4b14ead0.issuer.idp",
"jwksUri" : "https://a4cbe480-5263-4e03-ab7a-d60a4b14ead0.issuer.idp/jwks",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 419
{
"id" : "a47a767e-4a06-40a2-9875-fbf9cef26a13",
"issuer" : "https://a4cbe480-5263-4e03-ab7a-d60a4b14ead0.issuer.idp",
"jwksUri" : "https://a4cbe480-5263-4e03-ab7a-d60a4b14ead0.issuer.idp/jwks",
"active" : true,
"createdBy" : "e5368086-6212-4524-8fb9-8f123e4c8f4d",
"createdAt" : {
"nano" : 806657000,
"epochSecond" : 1746474601
},
"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/0403ff00-8a81-4b74-a56f-088436c83c02' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"issuer" : "https://205566f9-0efd-4e74-bdd4-873086a488ba.issuer.idp",
"jwksUri" : "https://205566f9-0efd-4e74-bdd4-873086a488ba.issuer.idp/jwks",
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
{
"id" : "0403ff00-8a81-4b74-a56f-088436c83c02",
"issuer" : "https://205566f9-0efd-4e74-bdd4-873086a488ba.issuer.idp",
"jwksUri" : "https://205566f9-0efd-4e74-bdd4-873086a488ba.issuer.idp/jwks",
"active" : false,
"createdBy" : "31ce64b0-a1bd-4683-8ed6-db3bfd8d17be",
"createdAt" : {
"nano" : 749685000,
"epochSecond" : 1746474601
},
"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/37d76870-618d-498a-b482-4b09b53a2d3d' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "37d76870-618d-498a-b482-4b09b53a2d3d",
"issuer" : "https://c205439f-6776-4089-a09e-4c58dfe51c0a.issuer.idp",
"jwksUri" : "https://c205439f-6776-4089-a09e-4c58dfe51c0a.issuer.idp/jwks",
"active" : true,
"createdBy" : "f7799699-b1b2-4a17-a42e-51da20f83e16",
"createdAt" : {
"nano" : 894607000,
"epochSecond" : 1746474601
},
"deletedAt" : {
"nano" : 903361000,
"epochSecond" : 1746474601
},
"deletedBy" : "dd9e2b3a-cc22-4533-ac3d-099836303185",
"deleted" : true
}
OIDC Public Clients
Find Oidc Public Clients
GET /oidc-public-clients
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2068
[ {
"id" : "24fde396-c303-4694-83f7-9471240b4f86",
"oidcIssuerId" : "084de902-b962-4b5b-a19c-58a87916d750",
"clientId" : "clientId-4aacf12e-c46f-4804-bb44-93bab0d6b139",
"clientSecret" : "clientSecret-ff027c79-2701-4df1-89fe-5a46a3ef7524",
"authorizationEndpoint" : "https://e119e416-b054-4133-bf9a-a7635dbc56da.issuer.idp/authorize",
"tokenEndpoint" : "https://e119e416-b054-4133-bf9a-a7635dbc56da.issuer.idp/token",
"userInfoEndpoint" : "https://e119e416-b054-4133-bf9a-a7635dbc56da.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "b9916cf3-c427-4be6-9d24-ebdcb4135113",
"createdAt" : {
"nano" : 988811000,
"epochSecond" : 1746474601
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"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" : 97895000,
"epochSecond" : 1746474551
},
"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" : 97895000,
"epochSecond" : 1746474551
},
"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/89e93253-ecff-455e-8d54-c8cbd767a420' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776
{
"id" : "89e93253-ecff-455e-8d54-c8cbd767a420",
"oidcIssuerId" : "0acd6426-5da2-4d50-916b-a6326a0eb647",
"clientId" : "clientId-ddbc7387-a3dd-4479-b226-e1d4a02a7424",
"clientSecret" : "clientSecret-2f281df5-ca3e-4f0b-b2fb-ef723838cc25",
"authorizationEndpoint" : "https://c773e041-9c86-464b-9046-52232c8f4bea.issuer.idp/authorize",
"tokenEndpoint" : "https://c773e041-9c86-464b-9046-52232c8f4bea.issuer.idp/token",
"userInfoEndpoint" : "https://c773e041-9c86-464b-9046-52232c8f4bea.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "56da63db-4ac7-4e1a-8866-388d3b2b759e",
"createdAt" : {
"nano" : 447184000,
"epochSecond" : 1746474602
},
"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" : "9a8e3c1a-6931-4ef8-bce2-168bab1bd198",
"clientId" : "clientId-1e6baf3b-42b5-4e28-a543-a705f0293181",
"clientSecret" : "clientSecret-8fd399da-b235-4ed9-a5fa-05d5fcbf8302",
"authorizationEndpoint" : "https://af348739-0b23-4319-ae59-3b7be850e315.issuer.idp/authorize",
"tokenEndpoint" : "https://af348739-0b23-4319-ae59-3b7be850e315.issuer.idp/token",
"userInfoEndpoint" : "https://af348739-0b23-4319-ae59-3b7be850e315.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 776
{
"id" : "82467157-fbc2-4b77-a22c-f0273cafd33f",
"oidcIssuerId" : "9a8e3c1a-6931-4ef8-bce2-168bab1bd198",
"clientId" : "clientId-1e6baf3b-42b5-4e28-a543-a705f0293181",
"clientSecret" : "clientSecret-8fd399da-b235-4ed9-a5fa-05d5fcbf8302",
"authorizationEndpoint" : "https://af348739-0b23-4319-ae59-3b7be850e315.issuer.idp/authorize",
"tokenEndpoint" : "https://af348739-0b23-4319-ae59-3b7be850e315.issuer.idp/token",
"userInfoEndpoint" : "https://af348739-0b23-4319-ae59-3b7be850e315.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "f49cdd15-9e90-4e37-a243-17c854cb2b1d",
"createdAt" : {
"nano" : 401427000,
"epochSecond" : 1746474602
},
"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/cb8aafdd-cb3a-4ecf-92c1-ec9bfc36e7e1' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"clientId" : "clientId-11c61718-387c-4457-b744-7a8ab2460299",
"clientSecret" : "clientSecret-0b98217a-0283-492f-b097-ded0e05eb87b",
"authorizationEndpoint" : "https://7de0a54f-b2dc-4385-8d60-ece63e4936fc.issuer.idp/authorize",
"tokenEndpoint" : "https://7de0a54f-b2dc-4385-8d60-ece63e4936fc.issuer.idp/token",
"userInfoEndpoint" : "https://7de0a54f-b2dc-4385-8d60-ece63e4936fc.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 777
{
"id" : "cb8aafdd-cb3a-4ecf-92c1-ec9bfc36e7e1",
"oidcIssuerId" : "0657d60c-a070-46e6-95ee-7c03cbd23aab",
"clientId" : "clientId-11c61718-387c-4457-b744-7a8ab2460299",
"clientSecret" : "clientSecret-0b98217a-0283-492f-b097-ded0e05eb87b",
"authorizationEndpoint" : "https://7de0a54f-b2dc-4385-8d60-ece63e4936fc.issuer.idp/authorize",
"tokenEndpoint" : "https://7de0a54f-b2dc-4385-8d60-ece63e4936fc.issuer.idp/token",
"userInfoEndpoint" : "https://7de0a54f-b2dc-4385-8d60-ece63e4936fc.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "b76cbcc5-2081-4504-b4cc-e31a6ac4a3ee",
"createdAt" : {
"nano" : 332010000,
"epochSecond" : 1746474602
},
"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/92dbe67c-259a-4021-bc6c-96f57c889d40' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 865
{
"id" : "92dbe67c-259a-4021-bc6c-96f57c889d40",
"oidcIssuerId" : "be80da08-ce03-4569-8519-8849b92289a4",
"clientId" : "clientId-d0c19e05-ca8b-4b44-bf8d-2c0dabd2e6a5",
"clientSecret" : "clientSecret-7c5470d5-dfbb-4524-8961-7d7826fcf33a",
"authorizationEndpoint" : "https://5e3a5396-7bad-41a3-8e27-8e79425aa2fa.issuer.idp/authorize",
"tokenEndpoint" : "https://5e3a5396-7bad-41a3-8e27-8e79425aa2fa.issuer.idp/token",
"userInfoEndpoint" : "https://5e3a5396-7bad-41a3-8e27-8e79425aa2fa.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "61645354-1bc5-4442-92ef-b28b49f9b512",
"createdAt" : {
"nano" : 501990000,
"epochSecond" : 1746474602
},
"deletedAt" : {
"nano" : 511646000,
"epochSecond" : 1746474602
},
"deletedBy" : "a60128f0-9d1d-425f-a07d-6297e13c63b7",
"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: 1514
[ {
"id" : "3cb422cd-37c7-47ad-b115-c5a82932b686",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"oidcPublicClientId" : "f4e6fcd0-1839-4566-8828-856e42b8f156",
"name" : "Google-Account",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "6f068f64-22e0-4631-be1c-f811c5656f12",
"createdAt" : {
"nano" : 752269000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "41c47111-1519-4e9e-940f-32cdbcb6d4ae",
"organizationId" : "afd636d5-ddb7-4a2b-ac0e-4921df7df6ae",
"oidcPublicClientId" : "37b6ddcb-2953-4bd4-a346-5f311fdcd0f5",
"name" : "console-client-2ab94168-adf4-4372-81a0-8778ebbea6ed",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "3d6aa3ec-9d1d-4d23-9329-63631c0783e0",
"createdAt" : {
"nano" : 504678000,
"epochSecond" : 1746474603
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "44e6382d-457e-4f4e-b146-caf6512520c8",
"organizationId" : "f86122fb-316b-4427-8c38-248165bf4504",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "NFSUPPORT Google Account",
"active" : true,
"customQueryParameters" : "{\"audience\": \"https://gateway.{env}.netfoundry.io/\", \"connection\": \"google-oauth2\"}",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 597698000,
"epochSecond" : 1746474550
},
"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/77947cdb-ad3a-4f2f-8945-bbe884acb3b4' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 493
{
"id" : "77947cdb-ad3a-4f2f-8945-bbe884acb3b4",
"organizationId" : "1bdc8aed-8b26-4e8b-a985-4d35871aa886",
"oidcPublicClientId" : "ad2cb0b4-101a-4dcc-bb17-1ee950e2ef02",
"name" : "console-client-39f4b108-55f2-4c69-be08-e2b58660c1dc",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "c66f9420-a277-46bf-9b41-763538f997f9",
"createdAt" : {
"nano" : 889935000,
"epochSecond" : 1746474603
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Organization Oidc Public Client Mapping
POST /organization-oidc-public-client-mappings
Authorization
This endpoint requires:
-
create
action on thisorganization-oidc-public-client-mapping
resource. -
read
action on theoidc-public-client
resource identified by theoidcPublicClientId
property.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "adbfa550-f93a-4bb5-b825-8c1da0015096",
"oidcPublicClientId" : "9150b86d-e1e0-491d-8f80-2716b63b271e",
"name" : "console-client-bad459b2-537c-49bc-b3e9-3a7ec5bbde5c",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 493
{
"id" : "7dc7ccf4-9ac2-4b8f-84ee-b300e37ee67c",
"organizationId" : "adbfa550-f93a-4bb5-b825-8c1da0015096",
"oidcPublicClientId" : "9150b86d-e1e0-491d-8f80-2716b63b271e",
"name" : "console-client-bad459b2-537c-49bc-b3e9-3a7ec5bbde5c",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "293ed69d-8a40-415f-a029-fdb07d274891",
"createdAt" : {
"nano" : 847589000,
"epochSecond" : 1746474603
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Organization Oidc Public Client Mapping
PATCH /organization-oidc-public-client-mappings/{id}
Authorization
This endpoint requires:
-
update
action on thisorganization-oidc-public-client-mapping
resource.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
active |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/8cbf30eb-e4b5-44b5-ac91-6fa099ea6b52' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"name" : "custom-client-e4a20d88-aa7e-4dcc-8d0d-4e08106b45cf",
"active" : true
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "8cbf30eb-e4b5-44b5-ac91-6fa099ea6b52",
"organizationId" : "fe92734d-92f2-48ab-9a3f-725823db069e",
"oidcPublicClientId" : "fd8b57bb-6d84-46e6-aa13-301a5749d405",
"name" : "custom-client-e4a20d88-aa7e-4dcc-8d0d-4e08106b45cf",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "bdff3e90-8550-4d13-8b75-bf3abe54eaa2",
"createdAt" : {
"nano" : 785449000,
"epochSecond" : 1746474603
},
"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/826a1395-36be-4f91-bc54-035879dfecaa' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 541
{
"id" : "826a1395-36be-4f91-bc54-035879dfecaa",
"organizationId" : "cf24b9ae-e004-4b87-9fb7-9d48d137c6c0",
"oidcPublicClientId" : "84aeaea9-920a-4e92-af42-c55f5ff727ab",
"name" : "number two",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "273dd3f3-61b1-486c-9e57-31716a4ac219",
"createdAt" : {
"nano" : 939473000,
"epochSecond" : 1746474603
},
"deletedAt" : {
"nano" : 951435000,
"epochSecond" : 1746474603
},
"deletedBy" : "aa11615b-ad65-4b1c-a2a1-3253f617f5b3",
"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" : "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" : 105532000,
"epochSecond" : 1746474551
},
"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" : 105532000,
"epochSecond" : 1746474551
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "f38ccd72-a820-4660-a7d5-a27b8f4854fc",
"oidcIssuerId" : "7fc8961c-1188-4e73-8b50-e271d6782a8a",
"audience" : "mop-aud-e345e3b5-87ff-4a8a-b27f-81f23cd87dbf",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "d6fc48ae-0d7f-41d1-8662-a2897b9de9ab",
"createdAt" : {
"nano" : 655219000,
"epochSecond" : 1746474600
},
"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/21049372-06f8-4d76-9e54-8df3dc38cbcc' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430
{
"id" : "21049372-06f8-4d76-9e54-8df3dc38cbcc",
"oidcIssuerId" : "b87e4cec-7760-4fa5-9ad1-a725b7e7292d",
"audience" : "mop-aud-631ccff2-0920-4938-9065-f30916274d22",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "aa5c507c-082c-4e7e-8f62-a3653a10cda0",
"createdAt" : {
"nano" : 327739000,
"epochSecond" : 1746474601
},
"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" : "24b0604e-0276-45e6-86d7-32537f0bfc81",
"audience" : "mop-aud-c546262b-2954-4c2c-8237-974bd1bd4365",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "d93112b2-7689-4179-83f2-d4f17bb89419",
"oidcIssuerId" : "24b0604e-0276-45e6-86d7-32537f0bfc81",
"audience" : "mop-aud-c546262b-2954-4c2c-8237-974bd1bd4365",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "c5c250bc-23a7-4953-9c17-7f7db2595da5",
"createdAt" : {
"nano" : 289515000,
"epochSecond" : 1746474601
},
"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/c48d1c17-cb42-4bb3-bad0-3f717948b4de' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"audience" : "mop-aud-c8aac6be-535f-4cea-ade7-20b5d4560048",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "c48d1c17-cb42-4bb3-bad0-3f717948b4de",
"oidcIssuerId" : "9c425679-70a9-4136-bb42-b3a41891ee7b",
"audience" : "mop-aud-c8aac6be-535f-4cea-ade7-20b5d4560048",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "e5f408ff-9299-4e57-a294-26b1e304020d",
"createdAt" : {
"nano" : 188243000,
"epochSecond" : 1746474601
},
"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/fcfadfe3-00dc-492e-a54b-eec9d8d024e2' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 519
{
"id" : "fcfadfe3-00dc-492e-a54b-eec9d8d024e2",
"oidcIssuerId" : "1ebbcfed-12d5-4fed-9eb0-7f81cb898067",
"audience" : "mop-aud-6db75471-8232-4190-b68d-d5ce82ab39ae",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "574f29b4-844e-40d7-9acf-0f4839a751f1",
"createdAt" : {
"nano" : 378798000,
"epochSecond" : 1746474601
},
"deletedAt" : {
"nano" : 401284000,
"epochSecond" : 1746474601
},
"deletedBy" : "b4f75d27-7baa-4f4c-8978-449da2ca9a00",
"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/95a38065-f4be-4d94-80cc-802afbdab526' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 460
{
"id" : "95a38065-f4be-4d94-80cc-802afbdab526",
"userIdentityId" : "5e45b47c-c046-45bd-abb7-495b6994a53a",
"oidcAudienceId" : "d878e31c-28ec-4663-8333-5472ef102a96",
"subject" : "console-client-15be5218-872d-4f21-a928-5718184e9ad9",
"active" : true,
"createdBy" : "bc04ac0a-3a3a-4eb4-a7d7-105a531512c6",
"createdAt" : {
"nano" : 448767000,
"epochSecond" : 1746474606
},
"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" : "c3bfe41e-d02c-46c0-9252-172a5585781a",
"oidcAudienceId" : "b9b77fba-59ff-4608-873c-b3bcafcc710f",
"subject" : "console-client-68a831fa-1b6f-4c72-88b6-073d98ffa69c",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 460
{
"id" : "c98e7899-0565-4e21-bdbd-428de0d12e3c",
"userIdentityId" : "c3bfe41e-d02c-46c0-9252-172a5585781a",
"oidcAudienceId" : "b9b77fba-59ff-4608-873c-b3bcafcc710f",
"subject" : "console-client-68a831fa-1b6f-4c72-88b6-073d98ffa69c",
"active" : true,
"createdBy" : "7290ceb2-2746-4160-a14c-ec79151c41e8",
"createdAt" : {
"nano" : 399430000,
"epochSecond" : 1746474606
},
"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/123a9dc3-9147-49c8-bc2c-fae62940be78' -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" : "123a9dc3-9147-49c8-bc2c-fae62940be78",
"userIdentityId" : "2795442c-2924-4133-88f7-46d709824e5a",
"oidcAudienceId" : "53cd629c-0c2a-4b9b-a67d-a5d252e82116",
"subject" : "console-client-ccf1ad58-0d37-409f-b324-5ed62d077388",
"active" : false,
"createdBy" : "27198628-0c77-4582-86a1-24f4a7bbcf2c",
"createdAt" : {
"nano" : 307729000,
"epochSecond" : 1746474606
},
"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/0f154f3a-7a00-42b1-8c6f-f5b3c329b536' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 549
{
"id" : "0f154f3a-7a00-42b1-8c6f-f5b3c329b536",
"userIdentityId" : "a2d99c1a-bdd4-4ed8-ba79-74e310a959fc",
"oidcAudienceId" : "23a1fb1e-de87-47b9-aaa9-1c775d723acf",
"subject" : "console-client-f2419598-dfa7-4776-b83c-66a9565ced19",
"active" : true,
"createdBy" : "be77a3a4-dc9d-47db-b3b3-965335b37a91",
"createdAt" : {
"nano" : 502532000,
"epochSecond" : 1746474606
},
"deletedAt" : {
"nano" : 513180000,
"epochSecond" : 1746474606
},
"deletedBy" : "2e345c94-bf3a-4be6-9c47-6fdc93f6fee2",
"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: 1145
[ {
"id" : "052efba2-3dca-4358-b0a2-778325ae2ebd",
"organizationId" : "64b4a7ac-18fb-47a5-a34a-8259c3f3b649",
"auth0ConnectionId" : "auth0-opaque-connectionId-44",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 303481000,
"epochSecond" : 1746474595
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "1ed4ae0d-a703-4aff-99c7-48265fe4e7a1",
"organizationId" : "b6649f72-17ce-40a7-9900-67c5e59bcc9e",
"auth0ConnectionId" : "auth0-opaque-connectionId-64",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 620139000,
"epochSecond" : 1746474595
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "23e1c0c9-4073-4ee3-9721-cf18c3ac176b",
"organizationId" : "0e3c1ed0-38c5-4525-be5d-54c9fe4514b2",
"auth0ConnectionId" : "auth0-opaque-connectionId-62",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 538616000,
"epochSecond" : 1746474595
},
"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/bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 394
{
"id" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 649205000,
"epochSecond" : 1746474554
},
"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" : "dd71aaa2-2ca2-4c33-8794-26e17c820415",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 368
{
"id" : "62809ac6-24f0-4380-aa52-04f97e26c670",
"organizationId" : "dd71aaa2-2ca2-4c33-8794-26e17c820415",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 205076000,
"epochSecond" : 1746474599
},
"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/774420d4-296b-4aaf-afe7-08ed3d510023' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"name" : "New IdP Name"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "774420d4-296b-4aaf-afe7-08ed3d510023",
"organizationId" : "0da546f4-6d1e-4fcf-a1b1-594a8f510212",
"auth0ConnectionId" : "auth0-opaque-connectionId-209",
"name" : "New IdP Name",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 446633000,
"epochSecond" : 1746474599
},
"updatedAt" : {
"nano" : 460802000,
"epochSecond" : 1746474599
},
"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/5929b663-e977-42f4-8769-0d36f5370605/activate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "5929b663-e977-42f4-8769-0d36f5370605",
"organizationId" : "acb48fa1-5116-476b-9357-4d478ff7e646",
"auth0ConnectionId" : "auth0-opaque-connectionId-203",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 286315000,
"epochSecond" : 1746474599
},
"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/5c9fad70-0c38-4dcc-901d-f80120cb50f5' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "5c9fad70-0c38-4dcc-901d-f80120cb50f5",
"organizationId" : "8b69863b-22e8-4bd6-90ce-b10ea729bf97",
"auth0ConnectionId" : "auth0-opaque-connectionId-207",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 403024000,
"epochSecond" : 1746474599
},
"updatedAt" : {
"nano" : 414286000,
"epochSecond" : 1746474599
},
"deletedAt" : {
"nano" : 413000000,
"epochSecond" : 1746474599
}
}
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: 1325
[ {
"id" : "3ef89265-f068-4542-945f-50a118e91e93",
"organizationId" : "f86122fb-316b-4427-8c38-248165bf4504",
"name" : "Standard Role Admin - Network Group Admin of NF Support (NFSUP)",
"roleType" : "Standard",
"roleId" : "ddd39147-0ce2-473d-93c7-25b1b404433d",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 670851000,
"epochSecond" : 1746474550
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "411b57b5-7968-41c8-9250-7e02233cf7ce",
"organizationId" : "f86122fb-316b-4427-8c38-248165bf4504",
"name" : "NF Support - Intervention",
"roleType" : "Custom",
"roleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 599939000,
"epochSecond" : 1746474550
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "5ce73c73-da92-4c09-ae5c-658b0b9f7865",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "13a6c96b-5847-43b0-a034-3583cfc5e6a5",
"createdBy" : "02dc4c12-999e-4517-8464-74fe9bdc3a3c",
"createdAt" : {
"nano" : 756443000,
"epochSecond" : 1746474554
},
"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/5ce73c73-da92-4c09-ae5c-658b0b9f7865' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 419
{
"id" : "5ce73c73-da92-4c09-ae5c-658b0b9f7865",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "13a6c96b-5847-43b0-a034-3583cfc5e6a5",
"createdBy" : "02dc4c12-999e-4517-8464-74fe9bdc3a3c",
"createdAt" : {
"nano" : 756443000,
"epochSecond" : 1746474554
},
"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" : "0e3c1ed0-38c5-4525-be5d-54c9fe4514b2",
"roleType" : "Standard",
"roleId" : "83a50ad7-ed27-446f-8d0f-c15a55e3bf2d"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 458
{
"id" : "ff9d3008-4443-4b32-9e2f-62efbb2b8bc2",
"organizationId" : "0e3c1ed0-38c5-4525-be5d-54c9fe4514b2",
"name" : "Standard Role - 83a50ad7-ed27-446f-8d0f-c15a55e3bf2d",
"roleType" : "Standard",
"roleId" : "83a50ad7-ed27-446f-8d0f-c15a55e3bf2d",
"createdBy" : "e755fb1b-f8d6-4792-8635-145149606e7d",
"createdAt" : {
"nano" : 571617000,
"epochSecond" : 1746474595
},
"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/8151a926-1b0c-446d-ae53-6cde1634a592' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "8151a926-1b0c-446d-ae53-6cde1634a592",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Test Deletion",
"roleType" : "Standard",
"roleId" : "3ebae213-dc45-426c-90de-98919bac7136",
"createdBy" : "5173bc8a-873c-495f-bfd0-6f4afa4bc36d",
"createdAt" : {
"nano" : 348015000,
"epochSecond" : 1746474595
},
"deletedAt" : {
"nano" : 357000000,
"epochSecond" : 1746474595
},
"deletedBy" : "ca7809cc-42fc-4f92-bf53-ab7127db0e18",
"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/851dbade-d9fc-49f5-84b5-35776d04160b/grant' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"includeIdentityIds" : [ "3b03e300-541d-4743-98ea-5836f7210bf2", "98c82493-c07e-4cff-83bf-dd873736bb32", "ac2a4b84-731a-42b2-a142-51390ccf0d3f" ],
"excludeIdentityIds" : [ "98c82493-c07e-4cff-83bf-dd873736bb32", "cec2abdd-f042-46ab-8f6d-069eef4cc656", "ac2a4b84-731a-42b2-a142-51390ccf0d3f" ]
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51
{
"3b03e300-541d-4743-98ea-5836f7210bf2" : 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 |
---|---|---|---|
active |
Boolean |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
organizationId |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
id |
String |
true |
|
type |
String |
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" : "117c650b-5b81-4376-a1f1-a3da535f144a",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-305@acme.com",
"identityMappings" : [ {
"id" : "03abff87-b5a0-4be7-94ff-3f8a6a78c177",
"auth0UserId" : "auth0-opaque-userId-306",
"identityProviderId" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"userIdentityId" : "117c650b-5b81-4376-a1f1-a3da535f144a"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 340294000,
"epochSecond" : 1746474605
},
"deletedAt" : null,
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "First Last",
"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 |
---|---|---|---|
active |
Boolean |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
organizationId |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
id |
String |
true |
|
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identities/d71595ac-d7d7-46dd-91f5-5d9919103e0e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "ce18ae25-a10d-4b99-8472-5b36f2426380",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"userIdentityId" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 806291000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "John Doe",
"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 |
|
tenantId |
String |
true |
Deprecated.. |
name |
String |
true |
|
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: 2156
[ {
"id" : "0067fb39-4497-42f4-b105-6a849e34033b",
"organizationId" : "ea227c60-d2c1-4406-96ab-a0f344274bfc",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-53@acme.com",
"identityMappings" : [ {
"id" : "c6cf7827-ba37-4825-8a32-0be378881c03",
"auth0UserId" : "auth0-opaque-userId-54",
"identityProviderId" : "f2f2d472-6db8-4636-a2ca-e30f8ae3c7e5",
"userIdentityId" : "0067fb39-4497-42f4-b105-6a849e34033b"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 410914000,
"epochSecond" : 1746474595
},
"deletedAt" : null,
"tenantId" : "ea227c60-d2c1-4406-96ab-a0f344274bfc",
"name" : "First Last",
"type" : "UserIdentity"
}, {
"id" : "3873381d-8ad6-413e-b491-1e1e6d5bbad5",
"organizationId" : "b6649f72-17ce-40a7-9900-67c5e59bcc9e",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-65@acme.com",
"identityMappings" : [ {
"id" : "99bf33de-b988-4de3-8a1d-57347f22338e",
"auth0UserId" : "auth0-opaque-userId-66",
"identityProviderId" : "1ed4ae0d-a703-4aff-99c7-48265fe4e7a1",
"userIdentityId" : "3873381d-8ad6-413e-b491-1e1e6d5bbad5"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 624009000,
"epochSecond" : 1746474595
},
"deletedAt" : null,
"tenantId" : "b6649f72-17ce-40a7-9900-67c5e59bcc9e",
"name" : "First Last",
"type" : "UserIdentity"
}, {
"id" : "3a763739-5dd7-4be0-be1f-05ccd1b846e7",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-89@acme.com",
"identityMappings" : [ {
"id" : "94809e7e-c2f6-410a-a158-2f921443ba2f",
"auth0UserId" : "auth0-opaque-userId-90",
"identityProviderId" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"userIdentityId" : "3a763739-5dd7-4be0-be1f-05ccd1b846e7"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 700699000,
"epochSecond" : 1746474596
},
"deletedAt" : null,
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "First Last",
"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 |
|
tenantId |
String |
true |
Deprecated.. |
name |
String |
true |
|
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/d71595ac-d7d7-46dd-91f5-5d9919103e0e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "ce18ae25-a10d-4b99-8472-5b36f2426380",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"userIdentityId" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 806291000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "John Doe",
"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 |
|
tenantId |
String |
true |
Deprecated.. |
name |
String |
true |
|
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/mapping/auth0-opaque-userId-3/bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "ce18ae25-a10d-4b99-8472-5b36f2426380",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"userIdentityId" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 806291000,
"epochSecond" : 1746474554
},
"deletedAt" : null,
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "John Doe",
"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 |
|
tenantId |
String |
true |
Deprecated.. |
name |
String |
true |
|
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 479
{
"id" : "aa3c67cc-a8a1-4bbd-a045-f787c0dab7a9",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com",
"identityMappings" : [ ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 941336000,
"epochSecond" : 1746474605
},
"deletedAt" : null,
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Jane Doe",
"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 |
|
tenantId |
String |
true |
Deprecated.. |
name |
String |
true |
|
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/56c1d52f-3aae-46ff-a845-fd4a32b9451c' -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" : "56c1d52f-3aae-46ff-a845-fd4a32b9451c",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com",
"identityMappings" : [ {
"id" : "6f0b990e-e7d4-42c8-b0cf-67e7747642d2",
"auth0UserId" : "auth0-opaque-userId-310",
"identityProviderId" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"userIdentityId" : "56c1d52f-3aae-46ff-a845-fd4a32b9451c"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 525554000,
"epochSecond" : 1746474605
},
"deletedAt" : null,
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "Bobby White",
"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 |
|
tenantId |
String |
true |
Deprecated.. |
name |
String |
true |
|
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/47ae435b-8e92-491c-bdad-6538a1c0e7f7/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 719
{
"id" : "47ae435b-8e92-491c-bdad-6538a1c0e7f7",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-311@acme.com",
"identityMappings" : [ {
"id" : "d7f16018-5f68-4132-963e-70c7855dea5d",
"auth0UserId" : "auth0-opaque-userId-312",
"identityProviderId" : "bd1c4315-5a2e-4ec1-8e94-ad2a18c1566a",
"userIdentityId" : "47ae435b-8e92-491c-bdad-6538a1c0e7f7"
} ],
"identityAudienceMappings" : [ ],
"active" : false,
"createdAt" : {
"nano" : 587247000,
"epochSecond" : 1746474605
},
"deletedAt" : null,
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"name" : "First Last",
"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/66212ae0-e874-4c97-aef7-734971f2b779/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/16a9a44a-a010-412f-9adf-9cc6a7d31577/mapping' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"auth0UserId" : "new-auth0-userId:348a75e7-e0ba-4cd5-90d6-9f581d35b6f4",
"identityProviderId" : "670c506d-cca4-42c5-b152-9b3d9ae4844e"
}'
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: 2113
[ {
"id" : "0699c838-75e9-46fc-aecd-e7e767608367",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ClientId" : "3e923f0a-0668-4daf-a945-429140a11865",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "ACME Internal Service-11",
"contactEmail" : "service.admin-12@acme.com",
"description" : "updatable API Account description-13",
"active" : true,
"createdAt" : {
"nano" : 349997000,
"epochSecond" : 1746474557
},
"updatedAt" : {
"nano" : 385764000,
"epochSecond" : 1746474557
},
"deletedAt" : null,
"email" : "service.admin-12@acme.com",
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"type" : "ApiAccountIdentity"
}, {
"id" : "1656c809-fcb7-42b2-8a48-eb3bc0845bb5",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ClientId" : null,
"awsCognitoClientId" : "0c37b849-2edd-4af9-be91-91a64a8c5bf9|moawbaas",
"authenticationUrl" : "https://netfoundry-test-itiikj.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" : 289471000,
"epochSecond" : 1746474561
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "hr.director@acme.com",
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"type" : "ApiAccountIdentity"
}, {
"id" : "4617856a-15ce-4220-b373-92fa4c83e746",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ClientId" : null,
"awsCognitoClientId" : "e0ad4bf1-4b5d-4858-85ea-7224a6f39e1d|xfuhwgtr",
"authenticationUrl" : "https://netfoundry-test-vxcerm.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 725337000,
"epochSecond" : 1746474568
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"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/db24ae54-cbe8-4fe9-98a0-e0a68e01831f' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 718
{
"id" : "db24ae54-cbe8-4fe9-98a0-e0a68e01831f",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ClientId" : "961b1b72-f40d-4ac7-8de8-87b550556e41",
"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" : 846393000,
"epochSecond" : 1746474554
},
"updatedAt" : {
"nano" : 890565000,
"epochSecond" : 1746474556
},
"deletedAt" : null,
"email" : "no-reply@acme.com",
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"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/c8e644ab-8e16-4dbf-b3da-54992a6c3840' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 682
{
"id" : "699e783b-ada5-42de-8564-146b0bc89dc2",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ClientId" : "c8e644ab-8e16-4dbf-b3da-54992a6c3840",
"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" : 629204000,
"epochSecond" : 1746474594
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "service.admin-30@foo.com",
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"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" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"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" : "1656c809-fcb7-42b2-8a48-eb3bc0845bb5",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ClientId" : null,
"awsCognitoClientId" : "0c37b849-2edd-4af9-be91-91a64a8c5bf9|moawbaas",
"authenticationUrl" : "https://netfoundry-test-itiikj.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" : 289471000,
"epochSecond" : 1746474561
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "hr.director@acme.com",
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"type" : "ApiAccountIdentity"
},
"clientId" : "moawbaas",
"password" : "oqsgmkptrwekkckmfyiauypf",
"authenticationUrl" : "https://netfoundry-test-itiikj.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/7dd6a039-6a77-478c-b2da-868cbe379c0c' -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: 679
{
"id" : "7dd6a039-6a77-478c-b2da-868cbe379c0c",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ClientId" : "0c3cb7bc-30fe-4316-a8a3-2bef4b2e2849",
"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" : 908648000,
"epochSecond" : 1746474554
},
"updatedAt" : {
"nano" : 22139000,
"epochSecond" : 1746474556
},
"deletedAt" : null,
"email" : "robot@acme.com",
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"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/0cca63a5-c3af-4260-bd09-1aed6ff326e5/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 739
{
"id" : "0cca63a5-c3af-4260-bd09-1aed6ff326e5",
"organizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"auth0ClientId" : "ba338f5e-ed9f-497b-86e4-9638d295a3fd",
"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" : 501356000,
"epochSecond" : 1746474594
},
"updatedAt" : {
"nano" : 520680000,
"epochSecond" : 1746474594
},
"deletedAt" : null,
"email" : "service.admin-24@foo.com",
"tenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"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 |
|
toTenantId |
String |
true |
Deprecated.. |
state |
String |
true |
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" : "9189fdcf-8298-4abd-8aaf-ea54eb6469da",
"fromIdentityId" : "d4149512-ce31-4317-9607-f144efae50cd",
"toOrganizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 623386000,
"epochSecond" : 1747079399
},
"targetUserIdentityId" : "cbb45899-6893-4344-a65c-358c0b8db42d",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"toTenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"state" : "Open"
} ]
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 |
|
toTenantId |
String |
true |
Deprecated.. |
state |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/71a3c96c-ff8f-4941-a28f-e0a388d20447' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 526
{
"id" : "71a3c96c-ff8f-4941-a28f-e0a388d20447",
"fromIdentityId" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e",
"toOrganizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"invitedEmailAddress" : "new.employee-219@acme.com",
"expiration" : {
"nano" : 16184000,
"epochSecond" : 1747079400
},
"targetUserIdentityId" : "90b002d5-29ea-47bc-aa32-56aa2430cef2",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"toTenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"state" : "Open"
}
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 |
|
toTenantId |
String |
true |
Deprecated.. |
state |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"toOrganizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"invitedEmailAddress" : "new.employee@acme.com",
"invitationUrl" : "http://acme.console.netfoundry.io/invitation",
"targetUserIdentityId" : "cbb45899-6893-4344-a65c-358c0b8db42d",
"brandingOrganizationId" : null
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 523
{
"id" : "9189fdcf-8298-4abd-8aaf-ea54eb6469da",
"fromIdentityId" : "d4149512-ce31-4317-9607-f144efae50cd",
"toOrganizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 623386000,
"epochSecond" : 1747079399
},
"targetUserIdentityId" : "cbb45899-6893-4344-a65c-358c0b8db42d",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"toTenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"state" : "Open"
}
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 |
|
toTenantId |
String |
true |
Deprecated.. |
state |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/dfa4b845-2e45-45cf-90fe-7d043448127f/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 588
{
"id" : "dfa4b845-2e45-45cf-90fe-7d043448127f",
"fromIdentityId" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e",
"toOrganizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"invitedEmailAddress" : "new.employee-216@acme.com",
"expiration" : {
"nano" : 938698000,
"epochSecond" : 1747079399
},
"targetUserIdentityId" : "cb966bf9-9937-4980-806c-866e2ec40921",
"accepted" : false,
"revokedAt" : null,
"responseReceivedAt" : {
"nano" : 963514000,
"epochSecond" : 1746474599
},
"toTenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"state" : "Declined"
}
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 |
|
toTenantId |
String |
true |
Deprecated.. |
state |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/7c09558c-6a26-426e-b0a6-0dff0534eef9/revoke' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 641
{
"id" : "7c09558c-6a26-426e-b0a6-0dff0534eef9",
"fromIdentityId" : "d71595ac-d7d7-46dd-91f5-5d9919103e0e",
"toOrganizationId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"invitedEmailAddress" : "new.employee-222@acme.com",
"expiration" : {
"nano" : 89270000,
"epochSecond" : 1747079400
},
"targetUserIdentityId" : "26db5bcb-3e01-4653-9a24-57938f92b383",
"accepted" : null,
"revokedAt" : {
"nano" : 102622000,
"epochSecond" : 1746474600
},
"responseReceivedAt" : {
"nano" : 102626000,
"epochSecond" : 1746474600
},
"toTenantId" : "cdd47811-23ea-4357-9ada-01a0d40d4734",
"state" : "Revoked"
}
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/QLB7dcGbCXLt2KHObQbo4M1C0VSgTlR8GiHk' -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" : 439746000,
"epochSecond" : 1747079400
},
"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/mrExEL6duB1LxXht0iwCOSlLSMCEFN0tSnLc/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 524
{
"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" : 360742000,
"epochSecond" : 1747079400
},
"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/JihLqJaP8UYlVaFca6pyJ6J8CKxB4d9YyQAP/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.eyJpYXQiOjE3NDY0NzQ2MDAsImV4cCI6MTc0NjQ3NTUwMCwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJpbnZpdGF0aW9uIiwiaW52aXRhdGlvbklkIjoiYmU5MzYzZmItZGFhNi00ZmFjLWE2ZWEtMGZkNmIwOTBhMWNjIiwidGVuYW50TGFiZWwiOiJBQ01FLTAiLCJhdXRoMENvbm5lY3Rpb25JZHMiOlsiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0xIiwiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0yIl0sInJlZGlyZWN0VXJsIjoiaHR0cDovL2NvbnNvbGUubmZhZG1pbi5uZXRmb3VuZHJ5LmlvL2ludml0YXRpb24ifQ.WZWbj9X8ozKJnP5vqQc0juMZyKbVXLCf5CBsbfXInQorPhux-lop1KfiWSiP5f6ZTTLCbJoG4_Xt6VYHegLM8FSjyh-lJS_tMiaoQC2tV5K3vo1HAbNyyN9OZqt3UIII0zfZme7JBFu3UOPKVnDz-tie1cMse80jBPehkhETtxPL-h00s43wFUCkvcfbWw86gqNU5F5RfE5dwu6fAFav_hEyMUNMhUCz6BK9umDpBGMXHTvRPo01cGStXJcbtyv0gptiEvZnUe08I_OyOVCZJbbGGF0jgX86aZcg4nMpUF8KADCaNLyOFihxhhkw662IivLS6gBT-pvUHNZLe5E_Lg",
"auth0ConnectionIds" : [ "auth0-opaque-connectionId-1", "auth0-opaque-connectionId-2" ]
}
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.eyJpYXQiOjE3NDY0NzQ2MDAsImV4cCI6MTc0NjQ3NTUwMCwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJsb2dpbiIsInRlbmFudExhYmVsIjoiQUNNRS0wIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMSIsImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMiJdLCJyZWRpcmVjdFVybCI6Imh0dHA6Ly9jb25zb2xlLm5mYWRtaW4ubmV0Zm91bmRyeS5pby9pbnZpdGF0aW9uIn0.h66yIIkXyqpFHyHbdEOIPzRMYzYGdjPgDl29tbZHBdATuOWpBNHE4ysrbEVxY1Haw8XgH8ixDiwyZVMzHfMH8b4H5Cu9mYfjWC13G-MI2OSyvSWxWBibM789NY7tn4xjdMkXCs_RGcXmeR5vRDyuiYMmH4UUyNijj7S_d558-GWyxn2yk-KfgE4xCmRIg2K8Pl8ypqsVURaiW7wgh2QaUmQ9FwnKB2fmP5IqiLIWOg5gMplz_2RwC7qqmqkMk50BuS_GGHw0RrAZ74x5Kje3bf7QOsk_njkxSdf5mybXgDqG5taVSuFFYy7gfStF2SldDdd5KodbFIz-P_gsDhc56Q",
"auth0ConnectionIds" : [ "auth0-opaque-connectionId-1", "auth0-opaque-connectionId-2" ]
}
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: 1283
[ {
"id" : "03ee28b8-737a-4cfb-80bb-954a4fc4e9a6",
"userIdentityId" : "76718c85-0b06-4735-aab6-6ac019f8d61a",
"preferences" : {
"hello" : "world"
},
"createdBy" : "76718c85-0b06-4735-aab6-6ac019f8d61a",
"createdAt" : {
"nano" : 856396000,
"epochSecond" : 1746474596
},
"updatedAt" : {
"nano" : 856396000,
"epochSecond" : 1746474596
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "42387fd7-9f0f-4a97-bab3-d8279b2bbced",
"userIdentityId" : "c1a25811-fa49-4406-aa9d-391759e0e757",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "c1a25811-fa49-4406-aa9d-391759e0e757",
"createdAt" : {
"nano" : 637644000,
"epochSecond" : 1746474596
},
"updatedAt" : {
"nano" : 637644000,
"epochSecond" : 1746474596
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "caf0dbb6-4fb1-4f81-9bd7-939e00a6294a",
"userIdentityId" : "3a763739-5dd7-4be0-be1f-05ccd1b846e7",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "3a763739-5dd7-4be0-be1f-05ccd1b846e7",
"createdAt" : {
"nano" : 732725000,
"epochSecond" : 1746474596
},
"updatedAt" : {
"nano" : 732725000,
"epochSecond" : 1746474596
},
"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/4a74b4f4-19e7-4ae3-a389-3d87c1acd7a9' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "4a74b4f4-19e7-4ae3-a389-3d87c1acd7a9",
"userIdentityId" : "2892413b-51f0-4224-80d8-4d918bd22f0e",
"preferences" : {
"hello" : "world"
},
"createdBy" : "2892413b-51f0-4224-80d8-4d918bd22f0e",
"createdAt" : {
"nano" : 859322000,
"epochSecond" : 1746474597
},
"updatedAt" : {
"nano" : 859322000,
"epochSecond" : 1746474597
},
"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" : "d5db0c10-e730-467a-94b8-fe1a766ab164",
"userIdentityId" : "6d229d14-6e80-42bc-98bf-b61a3296a7dc",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "6d229d14-6e80-42bc-98bf-b61a3296a7dc",
"createdAt" : {
"nano" : 189438000,
"epochSecond" : 1746474597
},
"updatedAt" : {
"nano" : 189438000,
"epochSecond" : 1746474597
},
"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/0b7810a3-56d9-4b1a-a70d-38e695a2745a' -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" : "0b7810a3-56d9-4b1a-a70d-38e695a2745a",
"userIdentityId" : "5bbc2e1d-ba2e-454e-a1af-1e3d0ea6a82c",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "5bbc2e1d-ba2e-454e-a1af-1e3d0ea6a82c",
"createdAt" : {
"nano" : 704245000,
"epochSecond" : 1746474598
},
"updatedAt" : {
"nano" : 714719000,
"epochSecond" : 1746474598
},
"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/f53a431a-5980-4a4d-88c2-f26580aa943f' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "f53a431a-5980-4a4d-88c2-f26580aa943f",
"userIdentityId" : "aee8548b-1277-44cf-b6ab-68a14bb0bbd1",
"preferences" : {
"hello" : "world"
},
"createdBy" : "aee8548b-1277-44cf-b6ab-68a14bb0bbd1",
"createdAt" : {
"nano" : 540387000,
"epochSecond" : 1746474597
},
"updatedAt" : {
"nano" : 550361000,
"epochSecond" : 1746474597
},
"deletedBy" : "27212a17-b17d-4d15-957a-87a7ca308add",
"deletedAt" : {
"nano" : 550000000,
"epochSecond" : 1746474597
}
}
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" : "9a9a7432-39de-4f21-99ab-56cb8feb7c8d",
"organizationId" : "0fe8af38-2cbe-4c4e-b89b-62d30424c6d9",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "c98d3d5f-4016-4412-b32e-00cfbac0a217",
"createdAt" : {
"nano" : 329752000,
"epochSecond" : 1746474604
},
"updatedAt" : {
"nano" : 329752000,
"epochSecond" : 1746474604
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "d534431e-f894-444a-a9cc-a81872fdd20d",
"organizationId" : "fd7f96a0-8c7c-47f1-af86-35fc366648f1",
"preferences" : {
"hello" : "world"
},
"createdBy" : "d41fd491-3617-48c5-b277-7e5e7fe39eb1",
"createdAt" : {
"nano" : 258351000,
"epochSecond" : 1746474604
},
"updatedAt" : {
"nano" : 258351000,
"epochSecond" : 1746474604
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "eb622ed0-a37f-426e-a632-e1057a970aa8",
"organizationId" : "4dd029bf-439a-489e-96b1-4b5aecc2b389",
"preferences" : {
"hello" : "world"
},
"createdBy" : "c1f9c563-1829-4291-80f0-633863bfb592",
"createdAt" : {
"nano" : 404671000,
"epochSecond" : 1746474604
},
"updatedAt" : {
"nano" : 404671000,
"epochSecond" : 1746474604
},
"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/eb622ed0-a37f-426e-a632-e1057a970aa8' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "eb622ed0-a37f-426e-a632-e1057a970aa8",
"organizationId" : "4dd029bf-439a-489e-96b1-4b5aecc2b389",
"preferences" : {
"hello" : "world"
},
"createdBy" : "c1f9c563-1829-4291-80f0-633863bfb592",
"createdAt" : {
"nano" : 404671000,
"epochSecond" : 1746474604
},
"updatedAt" : {
"nano" : 404671000,
"epochSecond" : 1746474604
},
"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" : "0fe8af38-2cbe-4c4e-b89b-62d30424c6d9",
"preferences" : {
"first" : "my first preference."
}
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "9a9a7432-39de-4f21-99ab-56cb8feb7c8d",
"organizationId" : "0fe8af38-2cbe-4c4e-b89b-62d30424c6d9",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "c98d3d5f-4016-4412-b32e-00cfbac0a217",
"createdAt" : {
"nano" : 329752000,
"epochSecond" : 1746474604
},
"updatedAt" : {
"nano" : 329752000,
"epochSecond" : 1746474604
},
"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/2a3eea18-8f76-400a-bb7d-4dbfcfc6cf86' -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" : "2a3eea18-8f76-400a-bb7d-4dbfcfc6cf86",
"organizationId" : "78a59c9f-8b4f-4b15-a2b9-37c39684a578",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "2faf288e-cfe2-43fb-9fdf-bb7b0e08432b",
"createdAt" : {
"nano" : 524691000,
"epochSecond" : 1746474604
},
"updatedAt" : {
"nano" : 538051000,
"epochSecond" : 1746474604
},
"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/74c52a5b-9ed2-4bcd-9509-d4b60bba2806' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "74c52a5b-9ed2-4bcd-9509-d4b60bba2806",
"organizationId" : "f38e3419-39d2-4650-b170-053afcad2420",
"preferences" : {
"hello" : "world"
},
"createdBy" : "a1ccc962-1a77-4dc3-ac65-6bd7706e6f51",
"createdAt" : {
"nano" : 364547000,
"epochSecond" : 1746474604
},
"updatedAt" : {
"nano" : 373746000,
"epochSecond" : 1746474604
},
"deletedBy" : "aa6933d0-e748-4dc5-a975-2b6521beea29",
"deletedAt" : {
"nano" : 373000000,
"epochSecond" : 1746474604
}
}