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: 2366
[ {
"id" : "3032ed65-a563-45da-b68a-c6a57d607c55",
"name" : "World Wide Imports",
"label" : "WW-Imports-61",
"identityProviders" : [ {
"id" : "1db2f982-b7a9-4beb-8434-b19a48b28e9d",
"organizationId" : "3032ed65-a563-45da-b68a-c6a57d607c55",
"auth0ConnectionId" : "auth0-opaque-connectionId-62",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 896370000,
"epochSecond" : 1749574817
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "f83c986b-835d-4f4e-b313-4817b7581806",
"organizationId" : "3032ed65-a563-45da-b68a-c6a57d607c55",
"name" : "Standard Role - 66f01bda-729c-4356-97ad-99c780179334",
"roleType" : "Standard",
"roleId" : "66f01bda-729c-4356-97ad-99c780179334",
"createdBy" : "7c33f70b-fd86-4382-b649-ba1189e3e65c",
"createdAt" : {
"nano" : 962687000,
"epochSecond" : 1749574817
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 891432000,
"epochSecond" : 1749574817
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "3070aca8-cc1c-45af-9e07-a07353d20d21",
"name" : "World Wide Imports",
"label" : "WW-Imports-206",
"identityProviders" : [ ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 639049000,
"epochSecond" : 1749574822
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "3a45fc12-18c8-4629-9752-89709ba108d5",
"name" : "World Wide Imports",
"label" : "WW-Imports-118",
"identityProviders" : [ {
"id" : "91029192-089a-4ee6-bdd7-33d11c00a2a1",
"organizationId" : "3a45fc12-18c8-4629-9752-89709ba108d5",
"auth0ConnectionId" : "auth0-opaque-connectionId-119",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 290662000,
"epochSecond" : 1749574820
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 288897000,
"epochSecond" : 1749574820
},
"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" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 967123000,
"epochSecond" : 1749574775
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "87e68228-1b8e-4394-bd85-e34b3443b967",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 988938000,
"epochSecond" : 1749574775
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "f91fbcf2-3e48-4353-ae5a-3fe5458e6ac9",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "a77228ee-0d4e-4cd4-83d5-a89ffe59079b",
"createdBy" : "73bc8cf6-12b4-40b1-a75c-05731cb13602",
"createdAt" : {
"nano" : 153495000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "7ac70994-bb23-40c1-8881-0a5a944285dd",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "803f9602-e8c3-467d-ae5f-92970b44d14a",
"createdBy" : "ac7cea59-660c-471c-b243-9ee2a51544c6",
"createdAt" : {
"nano" : 142411000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 905319000,
"epochSecond" : 1749574775
},
"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/5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2071
{
"id" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 967123000,
"epochSecond" : 1749574775
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "87e68228-1b8e-4394-bd85-e34b3443b967",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 988938000,
"epochSecond" : 1749574775
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "f91fbcf2-3e48-4353-ae5a-3fe5458e6ac9",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "a77228ee-0d4e-4cd4-83d5-a89ffe59079b",
"createdBy" : "73bc8cf6-12b4-40b1-a75c-05731cb13602",
"createdAt" : {
"nano" : 153495000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "7ac70994-bb23-40c1-8881-0a5a944285dd",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "803f9602-e8c3-467d-ae5f-92970b44d14a",
"createdBy" : "ac7cea59-660c-471c-b243-9ee2a51544c6",
"createdAt" : {
"nano" : 142411000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 905319000,
"epochSecond" : 1749574775
},
"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" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 967123000,
"epochSecond" : 1749574775
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "87e68228-1b8e-4394-bd85-e34b3443b967",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 988938000,
"epochSecond" : 1749574775
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "f91fbcf2-3e48-4353-ae5a-3fe5458e6ac9",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "a77228ee-0d4e-4cd4-83d5-a89ffe59079b",
"createdBy" : "73bc8cf6-12b4-40b1-a75c-05731cb13602",
"createdAt" : {
"nano" : 153495000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "7ac70994-bb23-40c1-8881-0a5a944285dd",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "803f9602-e8c3-467d-ae5f-92970b44d14a",
"createdBy" : "ac7cea59-660c-471c-b243-9ee2a51544c6",
"createdAt" : {
"nano" : 142411000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 905319000,
"epochSecond" : 1749574775
},
"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" : "fb130bf9-15f5-483b-8231-c97dd0134485",
"name" : "Best Corp.",
"label" : "BEST-CORP",
"identityProviders" : [ {
"id" : "84d3fde0-c926-4b3d-a646-623761f47659",
"organizationId" : "fb130bf9-15f5-483b-8231-c97dd0134485",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Best Corp.",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 128068000,
"epochSecond" : 1749574826
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 126805000,
"epochSecond" : 1749574826
},
"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/910e1f88-ffae-46d8-949b-3d3f3c9b99b8/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 814
{
"id" : "910e1f88-ffae-46d8-949b-3d3f3c9b99b8",
"name" : "World Wide Imports",
"label" : "WW-Imports-248",
"identityProviders" : [ {
"id" : "f7ba48a7-45b5-4e35-a34a-053096c63140",
"organizationId" : "910e1f88-ffae-46d8-949b-3d3f3c9b99b8",
"auth0ConnectionId" : "auth0-opaque-connectionId-249",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 27699000,
"epochSecond" : 1749574827
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : false,
"mfaProvider" : null,
"createdAt" : {
"nano" : 26505000,
"epochSecond" : 1749574827
},
"updatedAt" : {
"nano" : 47063000,
"epochSecond" : 1749574827
},
"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/50209057-9150-4ce7-be5d-61078ecd7f1d/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" : "50209057-9150-4ce7-be5d-61078ecd7f1d",
"name" : "World Wide Imports",
"label" : "WW-Imports-244",
"identityProviders" : [ {
"id" : "a32767a6-6fa4-4c47-a926-86d681a5d92d",
"organizationId" : "50209057-9150-4ce7-be5d-61078ecd7f1d",
"auth0ConnectionId" : "auth0-opaque-connectionId-245",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 673001000,
"epochSecond" : 1749574826
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "15ed7739-893b-4773-8c0d-c5dd10e8baaf",
"organizationId" : "50209057-9150-4ce7-be5d-61078ecd7f1d",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 724616000,
"epochSecond" : 1749574826
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 670340000,
"epochSecond" : 1749574826
},
"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: 1218
[ {
"id" : "4655fce8-da37-48c7-90ed-59836f577ab5",
"issuer" : "https://55914b04-428b-4044-bb12-d41c9433a331.issuer.idp",
"jwksUri" : "https://55914b04-428b-4044-bb12-d41c9433a331.issuer.idp/jwks",
"active" : true,
"createdBy" : "3a21e6b1-b5f5-4b55-a169-b1167abbec9d",
"createdAt" : {
"nano" : 90602000,
"epochSecond" : 1749574824
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "6401ae50-168c-4a46-a739-8c458693009c",
"issuer" : "https://c72d4cf6-3588-475b-953f-e4415f2ce67e.issuer.idp",
"jwksUri" : "https://c72d4cf6-3588-475b-953f-e4415f2ce67e.issuer.idp/jwks",
"active" : true,
"createdBy" : "8729d531-4597-40af-8c04-f4213eba3cfa",
"createdAt" : {
"nano" : 722208000,
"epochSecond" : 1749574824
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "6c72dba0-a155-4804-9a70-89da12149793",
"issuer" : "https://accounts.google.com",
"jwksUri" : "https://www.googleapis.com/oauth2/v3/certs",
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 119201000,
"epochSecond" : 1749574772
},
"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/709cfb86-84ce-436d-a4ea-6f1f28c160e1' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 418
{
"id" : "709cfb86-84ce-436d-a4ea-6f1f28c160e1",
"issuer" : "https://ed580da1-36eb-47b4-b562-24cf7263fb90.issuer.idp",
"jwksUri" : "https://ed580da1-36eb-47b4-b562-24cf7263fb90.issuer.idp/jwks",
"active" : true,
"createdBy" : "280eca2c-4a6f-440c-9b76-5804082c9a6b",
"createdAt" : {
"nano" : 88410000,
"epochSecond" : 1749574825
},
"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://38b8ebf2-180b-45db-aee3-9f2b984c4067.issuer.idp",
"jwksUri" : "https://38b8ebf2-180b-45db-aee3-9f2b984c4067.issuer.idp/jwks",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 418
{
"id" : "36796f73-f8ad-4970-b559-8c7ffe15bab6",
"issuer" : "https://38b8ebf2-180b-45db-aee3-9f2b984c4067.issuer.idp",
"jwksUri" : "https://38b8ebf2-180b-45db-aee3-9f2b984c4067.issuer.idp/jwks",
"active" : true,
"createdBy" : "b35b55f5-e3ad-4e44-b202-b7ec649df386",
"createdAt" : {
"nano" : 49838000,
"epochSecond" : 1749574825
},
"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/20af8911-b2ed-4db7-81ba-4f63468ef84d' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"issuer" : "https://0acf3039-ddaf-49ef-a0bb-1a910e6feef3.issuer.idp",
"jwksUri" : "https://0acf3039-ddaf-49ef-a0bb-1a910e6feef3.issuer.idp/jwks",
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
{
"id" : "20af8911-b2ed-4db7-81ba-4f63468ef84d",
"issuer" : "https://0acf3039-ddaf-49ef-a0bb-1a910e6feef3.issuer.idp",
"jwksUri" : "https://0acf3039-ddaf-49ef-a0bb-1a910e6feef3.issuer.idp/jwks",
"active" : false,
"createdBy" : "5edb7564-db01-4973-bc8f-ec4999c2b604",
"createdAt" : {
"nano" : 965225000,
"epochSecond" : 1749574824
},
"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/6f8d33b8-eace-4a62-aede-780774462be4' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "6f8d33b8-eace-4a62-aede-780774462be4",
"issuer" : "https://f552f944-dd62-4dcf-b3ca-7c14e2498da9.issuer.idp",
"jwksUri" : "https://f552f944-dd62-4dcf-b3ca-7c14e2498da9.issuer.idp/jwks",
"active" : true,
"createdBy" : "101744da-bce3-42a1-9817-3e3a00b49eb7",
"createdAt" : {
"nano" : 136271000,
"epochSecond" : 1749574825
},
"deletedAt" : {
"nano" : 145691000,
"epochSecond" : 1749574825
},
"deletedBy" : "c665a71a-1c72-422b-ae81-a248bb358ea5",
"deleted" : true
}
OIDC Public Clients
Find Oidc Public Clients
GET /oidc-public-clients
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2070
[ {
"id" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"oidcIssuerId" : "fc221f2c-e97f-4994-a29e-afc26395f6b6",
"clientId" : "{clientId}",
"clientSecret" : "{clientSecret}",
"authorizationEndpoint" : "https://{auth0-tenant}.auth0.com/authorize",
"tokenEndpoint" : "https://{auth0-tenant}.auth0.com/oauth/token",
"userInfoEndpoint" : "https://{auth0-tenant}.auth0.com/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 120150000,
"epochSecond" : 1749574772
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "68c2f611-d1e1-48ac-a50b-509e7f8ef053",
"oidcIssuerId" : "dec200f9-5e7c-41ab-8c3b-78803e592195",
"clientId" : "clientId-08f3ae48-c707-448a-9111-673926a18215",
"clientSecret" : "clientSecret-c75bba3e-2ff1-4d21-bd7a-9bccbaaab1e0",
"authorizationEndpoint" : "https://d5819864-1a25-4ec3-b51b-4994af6cf559.issuer.idp/authorize",
"tokenEndpoint" : "https://d5819864-1a25-4ec3-b51b-4994af6cf559.issuer.idp/token",
"userInfoEndpoint" : "https://d5819864-1a25-4ec3-b51b-4994af6cf559.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "3d764bf4-7eb6-429a-beab-6b970aae9e72",
"createdAt" : {
"nano" : 253443000,
"epochSecond" : 1749574825
},
"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" : 120150000,
"epochSecond" : 1749574772
},
"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/61ea8999-73a2-464e-bda8-88764defc67a' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776
{
"id" : "61ea8999-73a2-464e-bda8-88764defc67a",
"oidcIssuerId" : "2f98a66e-8ae6-4589-843e-01f192ff853b",
"clientId" : "clientId-7ccd5eba-79c5-4269-9f44-c604eeed5c99",
"clientSecret" : "clientSecret-854b8606-01bc-471b-8df1-439babc60563",
"authorizationEndpoint" : "https://52a258e4-d4a6-42a1-95f1-a7db8ef11ce5.issuer.idp/authorize",
"tokenEndpoint" : "https://52a258e4-d4a6-42a1-95f1-a7db8ef11ce5.issuer.idp/token",
"userInfoEndpoint" : "https://52a258e4-d4a6-42a1-95f1-a7db8ef11ce5.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "bb8299da-5218-4af3-8bdf-910d22217e99",
"createdAt" : {
"nano" : 724954000,
"epochSecond" : 1749574825
},
"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" : "8869b4a5-389a-4d71-9436-ae736c5f6ec7",
"clientId" : "clientId-bb2d8ffe-3b4c-4506-be60-3402aeda6369",
"clientSecret" : "clientSecret-74088ab7-459a-4c36-884a-78b25dbc14fd",
"authorizationEndpoint" : "https://7da69d57-641c-46b7-a186-b84a087cc2b6.issuer.idp/authorize",
"tokenEndpoint" : "https://7da69d57-641c-46b7-a186-b84a087cc2b6.issuer.idp/token",
"userInfoEndpoint" : "https://7da69d57-641c-46b7-a186-b84a087cc2b6.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 776
{
"id" : "759a5e45-90bc-4361-bc82-b74b76d6bf10",
"oidcIssuerId" : "8869b4a5-389a-4d71-9436-ae736c5f6ec7",
"clientId" : "clientId-bb2d8ffe-3b4c-4506-be60-3402aeda6369",
"clientSecret" : "clientSecret-74088ab7-459a-4c36-884a-78b25dbc14fd",
"authorizationEndpoint" : "https://7da69d57-641c-46b7-a186-b84a087cc2b6.issuer.idp/authorize",
"tokenEndpoint" : "https://7da69d57-641c-46b7-a186-b84a087cc2b6.issuer.idp/token",
"userInfoEndpoint" : "https://7da69d57-641c-46b7-a186-b84a087cc2b6.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "04eaa6ba-b051-4939-abda-773212e8a849",
"createdAt" : {
"nano" : 683230000,
"epochSecond" : 1749574825
},
"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/4d7661eb-6ea5-4a44-a56f-4467a3c42d42' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"clientId" : "clientId-b99516d4-04a2-4b42-b239-1c74813a44b7",
"clientSecret" : "clientSecret-eddc6e5d-643b-4347-a1b7-a0430d7c3b4d",
"authorizationEndpoint" : "https://e6265c66-a1b4-4e75-b9f3-368f51f885f1.issuer.idp/authorize",
"tokenEndpoint" : "https://e6265c66-a1b4-4e75-b9f3-368f51f885f1.issuer.idp/token",
"userInfoEndpoint" : "https://e6265c66-a1b4-4e75-b9f3-368f51f885f1.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 777
{
"id" : "4d7661eb-6ea5-4a44-a56f-4467a3c42d42",
"oidcIssuerId" : "6d8bb555-6bc8-4ae9-a26c-e1d0805633e5",
"clientId" : "clientId-b99516d4-04a2-4b42-b239-1c74813a44b7",
"clientSecret" : "clientSecret-eddc6e5d-643b-4347-a1b7-a0430d7c3b4d",
"authorizationEndpoint" : "https://e6265c66-a1b4-4e75-b9f3-368f51f885f1.issuer.idp/authorize",
"tokenEndpoint" : "https://e6265c66-a1b4-4e75-b9f3-368f51f885f1.issuer.idp/token",
"userInfoEndpoint" : "https://e6265c66-a1b4-4e75-b9f3-368f51f885f1.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "9d0758ee-6165-4f72-acd0-6ff892ac300b",
"createdAt" : {
"nano" : 617844000,
"epochSecond" : 1749574825
},
"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/fe8a478a-6ecc-4eaf-8fe1-11cecdf94419' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 865
{
"id" : "fe8a478a-6ecc-4eaf-8fe1-11cecdf94419",
"oidcIssuerId" : "7ee43767-d4cd-4e7a-8e2c-d63ab2371604",
"clientId" : "clientId-b0cd86bc-4017-4a97-9cbb-b3f145f9d28e",
"clientSecret" : "clientSecret-48115d4e-097b-498a-a7d2-36872423d669",
"authorizationEndpoint" : "https://20f769a3-8130-4f7a-a875-d90c62735631.issuer.idp/authorize",
"tokenEndpoint" : "https://20f769a3-8130-4f7a-a875-d90c62735631.issuer.idp/token",
"userInfoEndpoint" : "https://20f769a3-8130-4f7a-a875-d90c62735631.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "0c36f97a-be5a-42cf-82e2-18700d39bbc2",
"createdAt" : {
"nano" : 782012000,
"epochSecond" : 1749574825
},
"deletedAt" : {
"nano" : 799451000,
"epochSecond" : 1749574825
},
"deletedBy" : "a60d32d3-ffb7-4cdc-a997-9f835f9110ed",
"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: 1497
[ {
"id" : "492dbc31-3bf7-4c0f-be14-fb2d4ea3a226",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "ACME Federated Active Directory",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "6fbf0b17-154e-4e67-a815-44178248149e",
"createdAt" : {
"nano" : 117989000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "5cfb2f9b-7cd4-41ee-8326-c69e4945c408",
"organizationId" : "cc2433a9-c951-4a30-a57f-c23567fe7b87",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "NFSUPPORT-RO Google Account",
"active" : true,
"customQueryParameters" : "{\"audience\": \"https://gateway.{env}.netfoundry.io/\", \"connection\": \"google-oauth2\"}",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 724498000,
"epochSecond" : 1749574771
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "6c933a98-93c7-467a-8aaf-8885cfdc4b4a",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"oidcPublicClientId" : "f4e6fcd0-1839-4566-8828-856e42b8f156",
"name" : "Google-Account",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "65343aaa-9360-4778-9911-44557a4b92b5",
"createdAt" : {
"nano" : 137990000,
"epochSecond" : 1749574776
},
"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/be11d35e-4d88-4d96-be28-9cbe478c27a1' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 493
{
"id" : "be11d35e-4d88-4d96-be28-9cbe478c27a1",
"organizationId" : "7ee14e21-f8c5-4235-a8a0-02bb6c7dcd98",
"oidcPublicClientId" : "6d2698ae-b211-4b5b-9cd0-bd5f36e574c1",
"name" : "console-client-c6ddb517-4340-4783-a15a-6bccf80f50ba",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "0f2a5155-27e8-448f-9109-5dbb1cc4873d",
"createdAt" : {
"nano" : 708710000,
"epochSecond" : 1749574827
},
"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" : "d3981f23-e554-4057-b5e3-817579933524",
"oidcPublicClientId" : "97633adc-888b-4d63-a014-abc0732228ce",
"name" : "console-client-5d6fac99-fac4-4385-86c3-fcbe315d8b41",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 493
{
"id" : "701b363d-49a9-4a7f-9409-47ce8c6195e4",
"organizationId" : "d3981f23-e554-4057-b5e3-817579933524",
"oidcPublicClientId" : "97633adc-888b-4d63-a014-abc0732228ce",
"name" : "console-client-5d6fac99-fac4-4385-86c3-fcbe315d8b41",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "8932c43b-2618-4a0f-a391-c539490068ad",
"createdAt" : {
"nano" : 661678000,
"epochSecond" : 1749574827
},
"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/38683d54-bf6e-4c3e-995a-bdfc0ba45dc1' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"name" : "custom-client-39e038b6-2a77-4f1f-a11c-c3006f67dcc0",
"active" : true
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "38683d54-bf6e-4c3e-995a-bdfc0ba45dc1",
"organizationId" : "44c3d265-97e4-428e-8607-d3c4628cf37c",
"oidcPublicClientId" : "48d3d49e-162c-47dc-8db2-feff6424cea7",
"name" : "custom-client-39e038b6-2a77-4f1f-a11c-c3006f67dcc0",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "8f6d0b4f-db7e-4220-a48b-4e14fb91c6bf",
"createdAt" : {
"nano" : 575975000,
"epochSecond" : 1749574827
},
"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/17c67968-8c12-4af3-be8c-5414d15e0746' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 541
{
"id" : "17c67968-8c12-4af3-be8c-5414d15e0746",
"organizationId" : "e9590667-10a1-45b7-9244-a124cf88f0e8",
"oidcPublicClientId" : "03d6ba53-e9ab-4b79-bd0f-2a954870e98e",
"name" : "number two",
"active" : true,
"customQueryParameters" : "",
"createdBy" : "11b87095-0f15-4983-9fdc-d6e174c05dd3",
"createdAt" : {
"nano" : 764425000,
"epochSecond" : 1749574827
},
"deletedAt" : {
"nano" : 776620000,
"epochSecond" : 1749574827
},
"deletedBy" : "f7433c7f-2fcb-4f76-afa3-c258e6b6b84f",
"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" : 128209000,
"epochSecond" : 1749574772
},
"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" : 128209000,
"epochSecond" : 1749574772
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "c57d341d-4d3c-40a4-8b12-4ca2b7de0283",
"oidcIssuerId" : "4655fce8-da37-48c7-90ed-59836f577ab5",
"audience" : "mop-aud-f0cf992e-9cc7-49ef-a97d-2b477e679acc",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "bb011f25-3d58-4343-bdd9-680bed44c707",
"createdAt" : {
"nano" : 105665000,
"epochSecond" : 1749574824
},
"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/a69c643f-3c22-43f6-8ac1-bd3f3204d83c' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430
{
"id" : "a69c643f-3c22-43f6-8ac1-bd3f3204d83c",
"oidcIssuerId" : "a38a0cd1-8cea-4b7b-b013-e911263c993c",
"audience" : "mop-aud-693f2031-0c17-4253-9896-880ec81ecd32",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "68d2acc7-b852-4779-9353-91e5ef799cee",
"createdAt" : {
"nano" : 546855000,
"epochSecond" : 1749574824
},
"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" : "e030e7e5-f64d-464d-9a7a-a0735eab6874",
"audience" : "mop-aud-2511cc10-2512-493a-bd4c-8eaa3a55dd7c",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "1435ee70-cbaa-4712-bd22-9422a20a3be4",
"oidcIssuerId" : "e030e7e5-f64d-464d-9a7a-a0735eab6874",
"audience" : "mop-aud-2511cc10-2512-493a-bd4c-8eaa3a55dd7c",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "dcff26b8-6928-45f7-86dd-ad21f93a9ebb",
"createdAt" : {
"nano" : 507226000,
"epochSecond" : 1749574824
},
"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/99720f7e-85c6-4c3c-972b-a6e14d18a6d4' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"audience" : "mop-aud-b306cab5-9e42-4cf4-89ea-c0dd99578ba8",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "99720f7e-85c6-4c3c-972b-a6e14d18a6d4",
"oidcIssuerId" : "8d636a06-a550-47aa-b714-dfd593c1c4e4",
"audience" : "mop-aud-b306cab5-9e42-4cf4-89ea-c0dd99578ba8",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "db64b472-81fd-44fc-87a7-756dd4ae8dd7",
"createdAt" : {
"nano" : 427262000,
"epochSecond" : 1749574824
},
"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/bdaa1b5d-8927-46f1-902f-e0647e80c79b' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 519
{
"id" : "bdaa1b5d-8927-46f1-902f-e0647e80c79b",
"oidcIssuerId" : "80011139-9f58-422c-b3aa-daaccdefaac6",
"audience" : "mop-aud-5585344d-c298-49a0-b816-4e178769f15a",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "b86d2174-310f-4afc-8a89-40b4a094aeb1",
"createdAt" : {
"nano" : 651429000,
"epochSecond" : 1749574824
},
"deletedAt" : {
"nano" : 665231000,
"epochSecond" : 1749574824
},
"deletedBy" : "bd064d2c-ca87-445a-8572-8d0b5c1b6d2d",
"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/b394e6d7-8cb5-4286-83b4-13ededfd386e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 460
{
"id" : "b394e6d7-8cb5-4286-83b4-13ededfd386e",
"userIdentityId" : "bcd5da82-6178-4d74-8d70-be758fe9ed89",
"oidcAudienceId" : "33fb0c35-964a-4730-bf59-c75adad774c9",
"subject" : "console-client-f6beda1a-f95e-4e82-bc63-7a2d2a31cba9",
"active" : true,
"createdBy" : "6e248110-35d5-4e82-bcb5-5be4e803072c",
"createdAt" : {
"nano" : 367651000,
"epochSecond" : 1749574830
},
"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" : "368de7b0-5387-4dbc-9507-6dc27aaeb73c",
"oidcAudienceId" : "61e0644c-9611-4790-b047-c1d8bf302417",
"subject" : "console-client-bbe4f2bd-3a5e-4bc7-ae9d-11d85c5eddca",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 460
{
"id" : "3893d724-2f8b-4caa-8554-18a1af7bd7aa",
"userIdentityId" : "368de7b0-5387-4dbc-9507-6dc27aaeb73c",
"oidcAudienceId" : "61e0644c-9611-4790-b047-c1d8bf302417",
"subject" : "console-client-bbe4f2bd-3a5e-4bc7-ae9d-11d85c5eddca",
"active" : true,
"createdBy" : "e191c407-82e9-410a-9a4b-b3276cb175e5",
"createdAt" : {
"nano" : 307386000,
"epochSecond" : 1749574830
},
"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/5baa93bd-5057-470c-a7c1-f315ef2e41ed' -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" : "5baa93bd-5057-470c-a7c1-f315ef2e41ed",
"userIdentityId" : "c8b59f1f-0648-4874-9ee0-ae752fc3d4b2",
"oidcAudienceId" : "62054fa8-28f0-42a2-95d1-b58ff11bbcf2",
"subject" : "console-client-9c02a1f9-b15a-4fc0-9153-a4a51eb4a04c",
"active" : false,
"createdBy" : "dcaa3d99-49a5-4da2-8599-bbb36628bf73",
"createdAt" : {
"nano" : 223981000,
"epochSecond" : 1749574830
},
"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/24973801-f5e7-4089-bd79-b66effd7fdd8' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 549
{
"id" : "24973801-f5e7-4089-bd79-b66effd7fdd8",
"userIdentityId" : "0b3221a2-af3d-4033-a95f-8e6d9a84cfd7",
"oidcAudienceId" : "91a0c63d-033b-41b1-b617-e3c9b30e3c3c",
"subject" : "console-client-fdf16daf-e341-4470-979d-8787c0d38979",
"active" : true,
"createdBy" : "8f65dadf-633e-42d3-ad50-f544b867dde6",
"createdAt" : {
"nano" : 423950000,
"epochSecond" : 1749574830
},
"deletedAt" : {
"nano" : 434634000,
"epochSecond" : 1749574830
},
"deletedBy" : "2baf50e3-786d-4008-916a-5f5bcf6259a1",
"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: 1146
[ {
"id" : "14872a63-f35e-44cc-9aba-68cacd3b86f4",
"organizationId" : "7528f757-d3d5-4e13-bfb7-424a1999d6a0",
"auth0ConnectionId" : "auth0-opaque-connectionId-193",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 98992000,
"epochSecond" : 1749574822
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "1db2f982-b7a9-4beb-8434-b19a48b28e9d",
"organizationId" : "3032ed65-a563-45da-b68a-c6a57d607c55",
"auth0ConnectionId" : "auth0-opaque-connectionId-62",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 896370000,
"epochSecond" : 1749574817
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "2121feb8-d0b7-4f9b-ae00-5e57d609fe8b",
"organizationId" : "537a9b8f-ed25-4b85-8cca-73c9f0e8fe66",
"auth0ConnectionId" : "auth0-opaque-connectionId-201",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 369107000,
"epochSecond" : 1749574822
},
"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/d5391d2c-a33f-4c78-9620-502ee671d078' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 394
{
"id" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 967123000,
"epochSecond" : 1749574775
},
"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" : "537a9b8f-ed25-4b85-8cca-73c9f0e8fe66",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 368
{
"id" : "86772319-5ae5-4d58-980d-9d7a5baa44be",
"organizationId" : "537a9b8f-ed25-4b85-8cca-73c9f0e8fe66",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 392991000,
"epochSecond" : 1749574822
},
"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/624357ae-7909-4b3b-a4c0-08c1db08fd15' -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" : "624357ae-7909-4b3b-a4c0-08c1db08fd15",
"organizationId" : "93cfeb65-5f1c-40b5-96d9-2af1265cedd6",
"auth0ConnectionId" : "auth0-opaque-connectionId-209",
"name" : "New IdP Name",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 710876000,
"epochSecond" : 1749574822
},
"updatedAt" : {
"nano" : 727059000,
"epochSecond" : 1749574822
},
"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/481c5551-d854-45d9-9742-6e3c39879731/activate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "481c5551-d854-45d9-9742-6e3c39879731",
"organizationId" : "933fe142-1d68-4f87-83b7-4e6371da4be3",
"auth0ConnectionId" : "auth0-opaque-connectionId-203",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 516855000,
"epochSecond" : 1749574822
},
"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/ff59f1c0-e2b8-4a59-9141-218bf692b1e9' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "ff59f1c0-e2b8-4a59-9141-218bf692b1e9",
"organizationId" : "3070aca8-cc1c-45af-9e07-a07353d20d21",
"auth0ConnectionId" : "auth0-opaque-connectionId-207",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 640371000,
"epochSecond" : 1749574822
},
"updatedAt" : {
"nano" : 653795000,
"epochSecond" : 1749574822
},
"deletedAt" : {
"nano" : 653000000,
"epochSecond" : 1749574822
}
}
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: 1327
[ {
"id" : "00d9beb0-c633-4cb0-86e0-b71e96ec0a43",
"organizationId" : "cc2433a9-c951-4a30-a57f-c23567fe7b87",
"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" : 759103000,
"epochSecond" : 1749574771
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "1e84d42d-0377-46bb-a448-8302e6d9af98",
"organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
"name" : "Cloud Engineering",
"roleType" : "Custom",
"roleId" : "8f1493a4-29ca-4b34-8d04-b6ef954b097c",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 830015000,
"epochSecond" : 1749574771
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "3021c189-9799-4218-a79e-e931a413aeba",
"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" : 688895000,
"epochSecond" : 1749574771
},
"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/f91fbcf2-3e48-4353-ae5a-3fe5458e6ac9' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
{
"id" : "f91fbcf2-3e48-4353-ae5a-3fe5458e6ac9",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "a77228ee-0d4e-4cd4-83d5-a89ffe59079b",
"createdBy" : "73bc8cf6-12b4-40b1-a75c-05731cb13602",
"createdAt" : {
"nano" : 153495000,
"epochSecond" : 1749574776
},
"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" : "3032ed65-a563-45da-b68a-c6a57d607c55",
"roleType" : "Standard",
"roleId" : "66f01bda-729c-4356-97ad-99c780179334"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 458
{
"id" : "f83c986b-835d-4f4e-b313-4817b7581806",
"organizationId" : "3032ed65-a563-45da-b68a-c6a57d607c55",
"name" : "Standard Role - 66f01bda-729c-4356-97ad-99c780179334",
"roleType" : "Standard",
"roleId" : "66f01bda-729c-4356-97ad-99c780179334",
"createdBy" : "7c33f70b-fd86-4382-b649-ba1189e3e65c",
"createdAt" : {
"nano" : 962687000,
"epochSecond" : 1749574817
},
"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/7639d17e-d79f-4b67-8a12-47adb2ac8fce' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "7639d17e-d79f-4b67-8a12-47adb2ac8fce",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Test Deletion",
"roleType" : "Standard",
"roleId" : "e6e6a0e1-726d-403a-a3ca-ae71b2caf417",
"createdBy" : "870859c2-b12e-46b8-8df7-eb345b0b8fc8",
"createdAt" : {
"nano" : 571888000,
"epochSecond" : 1749574817
},
"deletedAt" : {
"nano" : 589000000,
"epochSecond" : 1749574817
},
"deletedBy" : "392728cb-36aa-48c4-b85e-bad603be6076",
"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/6913a60f-7ef5-4825-be27-62d4792003f1/grant' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"includeIdentityIds" : [ "9c77450e-1fd2-42f5-95d3-a9b680bcac50", "95d75af7-b8b8-4235-9f98-e2ddb727ab32", "d9bff9b2-7b72-4a41-845d-9bad073217af" ],
"excludeIdentityIds" : [ "19cf2171-d67a-4e87-a4e3-dd37a889c99a", "95d75af7-b8b8-4235-9f98-e2ddb727ab32", "9c77450e-1fd2-42f5-95d3-a9b680bcac50" ]
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51
{
"d9bff9b2-7b72-4a41-845d-9bad073217af" : 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" : "94eb34db-a346-45fd-b055-5cb23112796c",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-305@acme.com",
"identityMappings" : [ {
"id" : "6ed1f69d-e24b-45f1-ae59-fa816dd11140",
"auth0UserId" : "auth0-opaque-userId-306",
"identityProviderId" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"userIdentityId" : "94eb34db-a346-45fd-b055-5cb23112796c"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 243443000,
"epochSecond" : 1749574829
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/fb0729cd-bbe0-4192-b7c1-068684ad4e66' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "6d6eed51-c107-4b38-9394-77ce525c6b7b",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"userIdentityId" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 190817000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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: 1919
[ {
"id" : "14d97964-273a-4814-b553-ac2e054541de",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com",
"identityMappings" : [ ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 787226000,
"epochSecond" : 1749574818
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"name" : "Jane Doe",
"type" : "UserIdentity"
}, {
"id" : "19cf2171-d67a-4e87-a4e3-dd37a889c99a",
"organizationId" : "bbf85c9b-d63d-48b5-8483-78fe855b7ee2",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-40@acme.com",
"identityMappings" : [ {
"id" : "439bb237-0f55-44a1-b714-a57fae54830b",
"auth0UserId" : "auth0-opaque-userId-41",
"identityProviderId" : "834d2e59-ad11-4cb4-97ad-260870da59b2",
"userIdentityId" : "19cf2171-d67a-4e87-a4e3-dd37a889c99a"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 109035000,
"epochSecond" : 1749574817
},
"deletedAt" : null,
"tenantId" : "bbf85c9b-d63d-48b5-8483-78fe855b7ee2",
"name" : "First Last",
"type" : "UserIdentity"
}, {
"id" : "243b8688-e236-42c1-b7ae-9bd7c028ee58",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-95@acme.com",
"identityMappings" : [ {
"id" : "bdf22802-ccd2-46e5-a417-66ef194b256d",
"auth0UserId" : "auth0-opaque-userId-96",
"identityProviderId" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"userIdentityId" : "243b8688-e236-42c1-b7ae-9bd7c028ee58"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 381420000,
"epochSecond" : 1749574819
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/fb0729cd-bbe0-4192-b7c1-068684ad4e66' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "6d6eed51-c107-4b38-9394-77ce525c6b7b",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"userIdentityId" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 190817000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/d5391d2c-a33f-4c78-9620-502ee671d078' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "6d6eed51-c107-4b38-9394-77ce525c6b7b",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"userIdentityId" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 190817000,
"epochSecond" : 1749574776
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 479
{
"id" : "17be05d0-7063-4323-b242-f19b96fc4edd",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com",
"identityMappings" : [ ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 844241000,
"epochSecond" : 1749574829
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/503387c2-8add-4b5b-945e-e0ff879eabf4' -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" : "503387c2-8add-4b5b-945e-e0ff879eabf4",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com",
"identityMappings" : [ {
"id" : "7d1853ec-9842-4dde-bce1-11bed547c080",
"auth0UserId" : "auth0-opaque-userId-310",
"identityProviderId" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"userIdentityId" : "503387c2-8add-4b5b-945e-e0ff879eabf4"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 451886000,
"epochSecond" : 1749574829
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/972bb459-71e8-410b-8a26-4c222801339f/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 719
{
"id" : "972bb459-71e8-410b-8a26-4c222801339f",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-311@acme.com",
"identityMappings" : [ {
"id" : "db69da1e-eff6-43bb-ae45-18bbc74196bc",
"auth0UserId" : "auth0-opaque-userId-312",
"identityProviderId" : "d5391d2c-a33f-4c78-9620-502ee671d078",
"userIdentityId" : "972bb459-71e8-410b-8a26-4c222801339f"
} ],
"identityAudienceMappings" : [ ],
"active" : false,
"createdAt" : {
"nano" : 517696000,
"epochSecond" : 1749574829
},
"deletedAt" : null,
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/45ad3434-3ef0-4a31-98f6-5f30a072c82f/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/2c659a67-7b96-46bd-bd92-afca9b787d2d/mapping' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"auth0UserId" : "new-auth0-userId:db4285cc-0ae6-4e2d-beaf-6ea27cc70e16",
"identityProviderId" : "87e68228-1b8e-4394-bd85-e34b3443b967"
}'
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: 2006
[ {
"id" : "03440735-1d05-406b-9cd4-68a6584bc6ae",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ClientId" : null,
"awsCognitoClientId" : "2478ab73-5188-4212-a005-cfc8391a63d4|xxmbptpt",
"authenticationUrl" : "https://netfoundry-test-qqaevq.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 339970000,
"epochSecond" : 1749574785
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"type" : "ApiAccountIdentity"
}, {
"id" : "06b20780-b4ae-45f4-a863-3690c0a86695",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ClientId" : null,
"awsCognitoClientId" : "2e6dabc1-728f-475d-8180-6a4f813ab226|mixwdaow",
"authenticationUrl" : "https://netfoundry-test-gschnq.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 126277000,
"epochSecond" : 1749574790
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"type" : "ApiAccountIdentity"
}, {
"id" : "23ab7d45-0b4d-42ef-9c05-6eec7ecbe52c",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ClientId" : null,
"awsCognitoClientId" : "2478ab73-5188-4212-a005-cfc8391a63d4|frfxebjp",
"authenticationUrl" : "https://netfoundry-test-qqaevq.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 424853000,
"epochSecond" : 1749574785
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/7e20357d-dfac-4bd1-a64e-587eea045435' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 718
{
"id" : "7e20357d-dfac-4bd1-a64e-587eea045435",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ClientId" : "b25429e2-d0b1-45b0-b2a3-0e5870aefa24",
"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" : 225014000,
"epochSecond" : 1749574776
},
"updatedAt" : {
"nano" : 242376000,
"epochSecond" : 1749574778
},
"deletedAt" : null,
"email" : "no-reply@acme.com",
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/7b59120c-1238-4fdf-8a4a-97c4fb24fe4e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 682
{
"id" : "92ce2b9a-91d8-4114-9ed6-3b5c5e9914ec",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ClientId" : "7b59120c-1238-4fdf-8a4a-97c4fb24fe4e",
"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" : 555268000,
"epochSecond" : 1749574816
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "service.admin-30@foo.com",
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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" : "ae1d82c6-c793-45f5-a35d-e10c57b2ed4e",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ClientId" : null,
"awsCognitoClientId" : "932355e7-a2c7-482c-b268-17e7bb8eac43|xnfpwvhh",
"authenticationUrl" : "https://netfoundry-test-enbetd.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" : 723984000,
"epochSecond" : 1749574782
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "hr.director@acme.com",
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"type" : "ApiAccountIdentity"
},
"clientId" : "xnfpwvhh",
"password" : "mfyadhaadrmskdlktvteljtm",
"authenticationUrl" : "https://netfoundry-test-enbetd.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/cab5f1d6-23d6-4580-aef9-6e89a19b006c' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"name" : "Robot",
"contactEmail" : "robot@acme.com",
"description" : "description here."
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 680
{
"id" : "cab5f1d6-23d6-4580-aef9-6e89a19b006c",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ClientId" : "ac6dead3-baf0-4fcb-98a5-27d8cb444dc5",
"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" : 251664000,
"epochSecond" : 1749574776
},
"updatedAt" : {
"nano" : 322443000,
"epochSecond" : 1749574777
},
"deletedAt" : null,
"email" : "robot@acme.com",
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/8497958c-e03b-4572-89d8-c7955f624eac/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 739
{
"id" : "8497958c-e03b-4572-89d8-c7955f624eac",
"organizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"auth0ClientId" : "11f51533-fe42-4465-b1d5-e467d9f64603",
"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" : 418332000,
"epochSecond" : 1749574816
},
"updatedAt" : {
"nano" : 439313000,
"epochSecond" : 1749574816
},
"deletedAt" : null,
"email" : "service.admin-24@foo.com",
"tenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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" : "82ebb444-9386-4a02-806e-449c66d3a83a",
"fromIdentityId" : "f0cb1896-456a-429e-8046-5c053d012057",
"toOrganizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 895716000,
"epochSecond" : 1750179622
},
"targetUserIdentityId" : "6ddf858a-6999-4829-b620-48ac178d259f",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"toTenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/f40ac117-c10a-4971-bd43-d34aca2e3aed' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 527
{
"id" : "f40ac117-c10a-4971-bd43-d34aca2e3aed",
"fromIdentityId" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66",
"toOrganizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"invitedEmailAddress" : "new.employee-219@acme.com",
"expiration" : {
"nano" : 384536000,
"epochSecond" : 1750179623
},
"targetUserIdentityId" : "06e1670d-c27d-4262-99fb-65d9ecad10d5",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"toTenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"invitedEmailAddress" : "new.employee@acme.com",
"invitationUrl" : "http://acme.console.netfoundry.io/invitation",
"targetUserIdentityId" : "6ddf858a-6999-4829-b620-48ac178d259f",
"brandingOrganizationId" : null
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 523
{
"id" : "82ebb444-9386-4a02-806e-449c66d3a83a",
"fromIdentityId" : "f0cb1896-456a-429e-8046-5c053d012057",
"toOrganizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 895716000,
"epochSecond" : 1750179622
},
"targetUserIdentityId" : "6ddf858a-6999-4829-b620-48ac178d259f",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"toTenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/56db0a34-17ea-447d-95d0-3a0ec1a76d1f/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 588
{
"id" : "56db0a34-17ea-447d-95d0-3a0ec1a76d1f",
"fromIdentityId" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66",
"toOrganizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"invitedEmailAddress" : "new.employee-216@acme.com",
"expiration" : {
"nano" : 232423000,
"epochSecond" : 1750179623
},
"targetUserIdentityId" : "a8f14ccb-a59c-4706-bdf8-d81462d04865",
"accepted" : false,
"revokedAt" : null,
"responseReceivedAt" : {
"nano" : 259636000,
"epochSecond" : 1749574823
},
"toTenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/736ec010-55df-4c37-94cc-792cec5f4a0f/revoke' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 642
{
"id" : "736ec010-55df-4c37-94cc-792cec5f4a0f",
"fromIdentityId" : "fb0729cd-bbe0-4192-b7c1-068684ad4e66",
"toOrganizationId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"invitedEmailAddress" : "new.employee-222@acme.com",
"expiration" : {
"nano" : 482418000,
"epochSecond" : 1750179623
},
"targetUserIdentityId" : "5a47e6e8-bcda-4542-ad6c-41c3a820d0b6",
"accepted" : null,
"revokedAt" : {
"nano" : 496706000,
"epochSecond" : 1749574823
},
"responseReceivedAt" : {
"nano" : 496709000,
"epochSecond" : 1749574823
},
"toTenantId" : "5070b3bd-b7be-4fea-b9fd-4fbc5cf790e4",
"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/iEeCtfKC3dK6SjhXnvVmCdBhBr6Ja0w1X09m' -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" : 892216000,
"epochSecond" : 1750179623
},
"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/D4DAxgTFscY1R0nHQpjU3Kg4rBQUCLq2Mo99/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" : 787628000,
"epochSecond" : 1750179623
},
"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/JrVo6CKUHvjXFJh7dmaHAf0DoLxUNRfeqsZY/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.eyJpYXQiOjE3NDk1NzQ4MjMsImV4cCI6MTc0OTU3NTcyMywiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJpbnZpdGF0aW9uIiwiaW52aXRhdGlvbklkIjoiOGVhNzYxY2QtOGI4OC00YzllLWExM2QtMWVlZDQzNzQwYmRiIiwidGVuYW50TGFiZWwiOiJBQ01FLTAiLCJhdXRoMENvbm5lY3Rpb25JZHMiOlsiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0xIiwiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0yIl0sInJlZGlyZWN0VXJsIjoiaHR0cDovL2NvbnNvbGUubmZhZG1pbi5uZXRmb3VuZHJ5LmlvL2ludml0YXRpb24ifQ.QclPa7rcPojnCIrfD0TbiV4L5DgyUFSjao36WNJ8sc5SNzGPiVJPEYD8-3HNeYZtSk2DcBJe2C0Oz91Vdgc4ccl0EfqVIonfSplfCyoSJOaX6foh0DAvrNoJMal7EU6wFV-kECN2R4sEG3wg3ox-UtFeYMIrEO5gEC5Tflq5qZoBGv47mJE7ZPSMud4mtbVthYpmXxoGTBJRkzz6UZwAh8_4Ra3y259INRZ1q_0HSxHevqb95JomcUirPK7AaGUM00GTNSZZDZTBdV2IW-pwJtxGa6-xVenMh09A-rb0nw1WI4-uOIzDjBg2mbKyUKd2Sn74SVMN8CQpaKH7pNja0w",
"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.eyJpYXQiOjE3NDk1NzQ4MjMsImV4cCI6MTc0OTU3NTcyMywiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJsb2dpbiIsInRlbmFudExhYmVsIjoiQUNNRS0wIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMSIsImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMiJdLCJyZWRpcmVjdFVybCI6Imh0dHA6Ly9jb25zb2xlLm5mYWRtaW4ubmV0Zm91bmRyeS5pby9pbnZpdGF0aW9uIn0.CG4nXS1f9HetuZ52jYBRsXZ07rjm5obLuANd_veNPpXjf4UOM_1Zrd50sguU3hFQE9bhWmJ4tpFVH6LA57UTaEZoCeGpqr16IMnqmnLQIhqda4I2FHsjRGLtl609urDVjEcwINAlqGaRiwKE3RJ9eumbFU6Sa8SZjQkfAPRKZ8iP4uA6Wmr__KRysoal3DSTzhjIonjRx3HN-B-MVemAsBk0im5xNMdZf7d4yO-KYdO8LIe89ciRFlBIgrwnYW75qBCzsa-trK3BbSZjMYxDFoDTDenpiqJPtF88P9g6ghP3n2IMpDP5nBorHvzqoWJicGcOCDmxkF1Pt1oM-EBUBg",
"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" : "77c38a0f-3eb7-4c5b-8af1-4b08c124be2a",
"userIdentityId" : "243b8688-e236-42c1-b7ae-9bd7c028ee58",
"preferences" : {
"hello" : "world"
},
"createdBy" : "243b8688-e236-42c1-b7ae-9bd7c028ee58",
"createdAt" : {
"nano" : 386098000,
"epochSecond" : 1749574819
},
"updatedAt" : {
"nano" : 386098000,
"epochSecond" : 1749574819
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "7afb4780-d7f5-4b31-a943-5e5a67b86b34",
"userIdentityId" : "a19b9ae1-678d-4ea1-89f6-915a9cb5dbc9",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "a19b9ae1-678d-4ea1-89f6-915a9cb5dbc9",
"createdAt" : {
"nano" : 332449000,
"epochSecond" : 1749574819
},
"updatedAt" : {
"nano" : 332449000,
"epochSecond" : 1749574819
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "7ce1f3db-fd50-4d1f-ba61-864a77d63727",
"userIdentityId" : "c064fd57-a95f-4824-9dc0-e114f727016c",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "c064fd57-a95f-4824-9dc0-e114f727016c",
"createdAt" : {
"nano" : 279138000,
"epochSecond" : 1749574819
},
"updatedAt" : {
"nano" : 279138000,
"epochSecond" : 1749574819
},
"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/1df68c10-a754-488e-9edb-1a8d9ad2712f' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 413
{
"id" : "1df68c10-a754-488e-9edb-1a8d9ad2712f",
"userIdentityId" : "b7f63c9e-471b-40b9-9d35-0a3e3b57e95e",
"preferences" : {
"hello" : "world"
},
"createdBy" : "b7f63c9e-471b-40b9-9d35-0a3e3b57e95e",
"createdAt" : {
"nano" : 16714000,
"epochSecond" : 1749574821
},
"updatedAt" : {
"nano" : 16714000,
"epochSecond" : 1749574821
},
"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" : "b916608d-ce18-46b4-958d-658e33a4b7eb",
"userIdentityId" : "116579d9-5ee6-4061-bc63-f4d00b12b5d6",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "116579d9-5ee6-4061-bc63-f4d00b12b5d6",
"createdAt" : {
"nano" : 877879000,
"epochSecond" : 1749574819
},
"updatedAt" : {
"nano" : 877879000,
"epochSecond" : 1749574819
},
"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/aa744f38-bb08-49dd-8965-3d11b3a4e9d6' -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" : "aa744f38-bb08-49dd-8965-3d11b3a4e9d6",
"userIdentityId" : "4d0042b8-4e06-4bb2-8b74-0eed05f20a21",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "4d0042b8-4e06-4bb2-8b74-0eed05f20a21",
"createdAt" : {
"nano" : 876724000,
"epochSecond" : 1749574821
},
"updatedAt" : {
"nano" : 892179000,
"epochSecond" : 1749574821
},
"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/6edff6d0-987b-455c-85af-61c8122760d4' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "6edff6d0-987b-455c-85af-61c8122760d4",
"userIdentityId" : "31e8233d-c655-4fdd-bcd2-3e2b50f21c45",
"preferences" : {
"hello" : "world"
},
"createdBy" : "31e8233d-c655-4fdd-bcd2-3e2b50f21c45",
"createdAt" : {
"nano" : 463983000,
"epochSecond" : 1749574820
},
"updatedAt" : {
"nano" : 506405000,
"epochSecond" : 1749574820
},
"deletedBy" : "0c06b609-451b-462d-8b4f-65f0bc7933e8",
"deletedAt" : {
"nano" : 505000000,
"epochSecond" : 1749574820
}
}
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: 1266
[ {
"id" : "1a1d9e97-491d-481a-a4df-4a0c3be20af7",
"organizationId" : "905f4dac-91a2-4648-8153-c7b0e0622ae5",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "47982a68-76f9-41e4-a7b3-a2e5c8d85814",
"createdAt" : {
"nano" : 118012000,
"epochSecond" : 1749574828
},
"updatedAt" : {
"nano" : 118012000,
"epochSecond" : 1749574828
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "27f4f809-9505-4b8e-8cdb-362aa0b4b9cd",
"organizationId" : "27b4c070-09b4-40c3-aecd-78dee0d2c9a0",
"preferences" : {
"hello" : "world"
},
"createdBy" : "d5aafa93-b6d5-426e-9540-61dbeec151ea",
"createdAt" : {
"nano" : 197613000,
"epochSecond" : 1749574828
},
"updatedAt" : {
"nano" : 197613000,
"epochSecond" : 1749574828
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "9181d2f3-69b4-42ab-83c0-b991b24cc97b",
"organizationId" : "4b60ece5-c96e-4ff0-9076-3c19cf1b5222",
"preferences" : {
"hello" : "world"
},
"createdBy" : "98743b14-0fc2-4592-9730-75a47729f9f8",
"createdAt" : {
"nano" : 52575000,
"epochSecond" : 1749574828
},
"updatedAt" : {
"nano" : 52575000,
"epochSecond" : 1749574828
},
"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/27f4f809-9505-4b8e-8cdb-362aa0b4b9cd' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "27f4f809-9505-4b8e-8cdb-362aa0b4b9cd",
"organizationId" : "27b4c070-09b4-40c3-aecd-78dee0d2c9a0",
"preferences" : {
"hello" : "world"
},
"createdBy" : "d5aafa93-b6d5-426e-9540-61dbeec151ea",
"createdAt" : {
"nano" : 197613000,
"epochSecond" : 1749574828
},
"updatedAt" : {
"nano" : 197613000,
"epochSecond" : 1749574828
},
"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" : "905f4dac-91a2-4648-8153-c7b0e0622ae5",
"preferences" : {
"first" : "my first preference."
}
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "1a1d9e97-491d-481a-a4df-4a0c3be20af7",
"organizationId" : "905f4dac-91a2-4648-8153-c7b0e0622ae5",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "47982a68-76f9-41e4-a7b3-a2e5c8d85814",
"createdAt" : {
"nano" : 118012000,
"epochSecond" : 1749574828
},
"updatedAt" : {
"nano" : 118012000,
"epochSecond" : 1749574828
},
"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/e5ee7bae-734a-4223-9804-49bae6d5c0f2' -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" : "e5ee7bae-734a-4223-9804-49bae6d5c0f2",
"organizationId" : "308c6eed-fcbd-4fc1-98b0-e8d43425966c",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "5bf56afe-3dae-4b7c-b551-b4314b4b1a43",
"createdAt" : {
"nano" : 406007000,
"epochSecond" : 1749574828
},
"updatedAt" : {
"nano" : 437950000,
"epochSecond" : 1749574828
},
"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/92666fce-3fe3-4580-b61d-a9e8d960259a' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "92666fce-3fe3-4580-b61d-a9e8d960259a",
"organizationId" : "5281d57b-2187-4bfc-885b-1a5093ee1bdb",
"preferences" : {
"hello" : "world"
},
"createdBy" : "548d06e8-fc2a-49e4-bfd0-ecf5fed458ab",
"createdAt" : {
"nano" : 154307000,
"epochSecond" : 1749574828
},
"updatedAt" : {
"nano" : 165016000,
"epochSecond" : 1749574828
},
"deletedBy" : "ffb846e8-4240-40e4-b59a-732e5f6c7690",
"deletedAt" : {
"nano" : 164000000,
"epochSecond" : 1749574828
}
}