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
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
active |
Boolean |
true |
|
mfaProviders |
Object |
true |
|
includeDeleted |
Boolean |
true |
Default value: 'false'. |
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI3UnF4QzZnYVVJZkN3TjVpaThqaWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3573
[ {
"id" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 845636000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "c666343e-9631-41cb-be7d-49bbac97b317",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 837402000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "1e7f459d-cf0b-48fd-b24c-f354805f6f02",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "e0f28edf-cef0-4fc5-8b80-1fc7cdb5acb1",
"createdBy" : "1c1fc1cb-b575-4c9e-8bd3-6cd11aa002b0",
"createdAt" : {
"nano" : 849911000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "0ac23b2a-5929-4766-938f-eb5c7fd49df3",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "8448a717-9950-48c4-9033-c2315f92e9de",
"createdBy" : "e0d21733-b04d-4cf2-b888-6aaf0da9edcd",
"createdAt" : {
"nano" : 860581000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 795318000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "5ea83fd7-e38f-4d2a-ae21-98a37ee7f0ff",
"name" : "Best Corp.",
"label" : "BEST-CORP",
"identityProviders" : [ {
"id" : "15ea15fd-53e2-48e9-86d2-e29a0dc80328",
"organizationId" : "5ea83fd7-e38f-4d2a-ae21-98a37ee7f0ff",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Best Corp.",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 430837000,
"epochSecond" : 1719915501
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 429768000,
"epochSecond" : 1719915501
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "8171fef3-9e9b-41b4-95cf-48f8a053f353",
"name" : "World Wide Imports",
"label" : "WW-Imports-39",
"identityProviders" : [ {
"id" : "93ccb86a-b513-489e-9304-2c58be1721d5",
"organizationId" : "8171fef3-9e9b-41b4-95cf-48f8a053f353",
"auth0ConnectionId" : "auth0-opaque-connectionId-40",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 214884000,
"epochSecond" : 1719915498
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 213024000,
"epochSecond" : 1719915498
},
"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}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/5947bad8-cab0-437d-a061-b1e498584f3f' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI3UnF4QzZnYVVJZkN3TjVpaThqaWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2071
{
"id" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 845636000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "c666343e-9631-41cb-be7d-49bbac97b317",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 837402000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "1e7f459d-cf0b-48fd-b24c-f354805f6f02",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "e0f28edf-cef0-4fc5-8b80-1fc7cdb5acb1",
"createdBy" : "1c1fc1cb-b575-4c9e-8bd3-6cd11aa002b0",
"createdAt" : {
"nano" : 849911000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "0ac23b2a-5929-4766-938f-eb5c7fd49df3",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "8448a717-9950-48c4-9033-c2315f92e9de",
"createdBy" : "e0d21733-b04d-4cf2-b888-6aaf0da9edcd",
"createdAt" : {
"nano" : 860581000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 795318000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}
Get Organization By Label
GET /organizations/label/{label:[-a-zA-Z0-9]{1,63}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
label |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI3UnF4QzZnYVVJZkN3TjVpaThqaWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2071
{
"id" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "ACME International, Inc.",
"label" : "ACME-0",
"identityProviders" : [ {
"id" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 845636000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "c666343e-9631-41cb-be7d-49bbac97b317",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ConnectionId" : "auth0-opaque-connectionId-1",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 837402000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "1e7f459d-cf0b-48fd-b24c-f354805f6f02",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "e0f28edf-cef0-4fc5-8b80-1fc7cdb5acb1",
"createdBy" : "1c1fc1cb-b575-4c9e-8bd3-6cd11aa002b0",
"createdAt" : {
"nano" : 849911000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "0ac23b2a-5929-4766-938f-eb5c7fd49df3",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "8448a717-9950-48c4-9033-c2315f92e9de",
"createdBy" : "e0d21733-b04d-4cf2-b888-6aaf0da9edcd",
"createdAt" : {
"nano" : 860581000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 795318000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}
Create Organization
POST /organizations
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI3UnF4QzZnYVVJZkN3TjVpaThqaWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-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" : "5ea83fd7-e38f-4d2a-ae21-98a37ee7f0ff",
"name" : "Best Corp.",
"label" : "BEST-CORP",
"identityProviders" : [ {
"id" : "15ea15fd-53e2-48e9-86d2-e29a0dc80328",
"organizationId" : "5ea83fd7-e38f-4d2a-ae21-98a37ee7f0ff",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Best Corp.",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 430837000,
"epochSecond" : 1719915501
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 429768000,
"epochSecond" : 1719915501
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}
Activate Or Deactivate Organization
PUT /organizations/{id}/{action:activate|deactivate}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
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/76f864d8-9554-4423-b859-5bf85a6858a0/deactivate' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI3UnF4QzZnYVVJZkN3TjVpaThqaWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 817
{
"id" : "76f864d8-9554-4423-b859-5bf85a6858a0",
"name" : "World Wide Imports",
"label" : "WW-Imports-103",
"identityProviders" : [ {
"id" : "88a20863-0786-4dff-b259-1ba336d0efcb",
"organizationId" : "76f864d8-9554-4423-b859-5bf85a6858a0",
"auth0ConnectionId" : "auth0-opaque-connectionId-104",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 194906000,
"epochSecond" : 1719915502
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : false,
"mfaProvider" : null,
"createdAt" : {
"nano" : 193507000,
"epochSecond" : 1719915502
},
"updatedAt" : {
"nano" : 232277000,
"epochSecond" : 1719915502
},
"deletedAt" : null,
"deleted" : false
}
Add Identity Provider (deprecated)
POST /organizations/{id}/identity-providers
Deprecated.
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/065c8cf6-8e07-46a1-98c6-657d0555c630/identity-providers' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI3UnF4QzZnYVVJZkN3TjVpaThqaWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"auth0ConnectionId":"auth0-opaque-connection","identityProviderName":"Corp SAML","auth0ConnectionType":"Enterprise"}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1154
{
"id" : "065c8cf6-8e07-46a1-98c6-657d0555c630",
"name" : "World Wide Imports",
"label" : "WW-Imports-101",
"identityProviders" : [ {
"id" : "5bdb8efd-7937-46d6-b83e-f69b2105cbcc",
"organizationId" : "065c8cf6-8e07-46a1-98c6-657d0555c630",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 3242000,
"epochSecond" : 1719915502
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "7f6c1ae1-c38c-4c31-8ed3-d2d59c3e98f9",
"organizationId" : "065c8cf6-8e07-46a1-98c6-657d0555c630",
"auth0ConnectionId" : "auth0-opaque-connectionId-102",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 973094000,
"epochSecond" : 1719915501
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 970176000,
"epochSecond" : 1719915501
},
"updatedAt" : null,
"deletedAt" : null,
"deleted" : false
}
OIDC Issuers
Find Oidc Issuers
GET /oidc-issuers
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJhaUJ1djB3cDNldGdfRDRFZlM2Z1ZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1265
[ {
"id" : "01f1a768-55f1-44e5-bfcd-eaa2e90bad2c",
"issuer" : "https://8c687a6b-a296-4dc6-92da-119630b80c6c.issuer.idp",
"jwksUri" : "https://8c687a6b-a296-4dc6-92da-119630b80c6c.issuer.idp/jwks",
"active" : true,
"createdBy" : "e1951e35-caa1-4eb1-8e97-9aecf0cdd0dd",
"createdAt" : {
"nano" : 178569000,
"epochSecond" : 1719915501
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "119e3f6e-af67-44a6-85f8-d48fcad85055",
"issuer" : "https://3fef9617-f45e-45f3-8654-8a581e21bb3d.issuer.idp",
"jwksUri" : "https://3fef9617-f45e-45f3-8654-8a581e21bb3d.issuer.idp/jwks",
"active" : true,
"createdBy" : "b73ee0bf-d0d3-4083-8354-a625e01311aa",
"createdAt" : {
"nano" : 798252000,
"epochSecond" : 1719915496
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "279b989f-c54b-4ab7-beee-dc6b8aa0b4be",
"issuer" : "https://cda6f4a2-1e91-4faa-969e-717a55f0e59b.issuer.idp",
"jwksUri" : "https://cda6f4a2-1e91-4faa-969e-717a55f0e59b.issuer.idp/jwks",
"active" : true,
"createdBy" : "f8878de0-a1c6-4067-a298-fa1a25697ffb",
"createdAt" : {
"nano" : 290486000,
"epochSecond" : 1719915497
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Oidc Issuer
GET /oidc-issuers/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/2d3475d8-b328-4b6d-91af-b0fd9230a714' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJhaUJ1djB3cDNldGdfRDRFZlM2Z1ZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 418
{
"id" : "2d3475d8-b328-4b6d-91af-b0fd9230a714",
"issuer" : "https://5f2f364c-8ba2-4249-99ee-cd18d1250c00.issuer.idp",
"jwksUri" : "https://5f2f364c-8ba2-4249-99ee-cd18d1250c00.issuer.idp/jwks",
"active" : true,
"createdBy" : "5ed52594-dfb0-4871-814c-1d0795d2c658",
"createdAt" : {
"nano" : 75274000,
"epochSecond" : 1719915505
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Issuer
POST /oidc-issuers
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJhaUJ1djB3cDNldGdfRDRFZlM2Z1ZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"issuer":"https://4ad530c1-af1e-4ad5-8099-69dc26ef956c.issuer.idp","jwksUri":"https://4ad530c1-af1e-4ad5-8099-69dc26ef956c.issuer.idp/jwks","active":true}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 418
{
"id" : "9f10c32c-cedd-4b29-9162-9aa449f39dc0",
"issuer" : "https://4ad530c1-af1e-4ad5-8099-69dc26ef956c.issuer.idp",
"jwksUri" : "https://4ad530c1-af1e-4ad5-8099-69dc26ef956c.issuer.idp/jwks",
"active" : true,
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 43456000,
"epochSecond" : 1719915505
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Issuer
PATCH /oidc-issuers/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/9a62bb2e-b9a4-46d3-a9eb-0b35db44c7d6' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJhaUJ1djB3cDNldGdfRDRFZlM2Z1ZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"issuer":"https://7f99745f-beda-426c-8951-4bf7946ad07f.issuer.idp","jwksUri":"https://7f99745f-beda-426c-8951-4bf7946ad07f.issuer.idp/jwks","active":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
{
"id" : "9a62bb2e-b9a4-46d3-a9eb-0b35db44c7d6",
"issuer" : "https://7f99745f-beda-426c-8951-4bf7946ad07f.issuer.idp",
"jwksUri" : "https://7f99745f-beda-426c-8951-4bf7946ad07f.issuer.idp/jwks",
"active" : false,
"createdBy" : "e9971361-fd6e-415e-bd40-7854417401b8",
"createdAt" : {
"nano" : 935858000,
"epochSecond" : 1719915504
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Issuer
DELETE /oidc-issuers/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/e703ea69-0f64-46c1-ab31-d34e7acda14b' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJhaUJ1djB3cDNldGdfRDRFZlM2Z1ZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "e703ea69-0f64-46c1-ab31-d34e7acda14b",
"issuer" : "https://16a52778-2ada-45ac-87c7-93f2f1ad637f.issuer.idp",
"jwksUri" : "https://16a52778-2ada-45ac-87c7-93f2f1ad637f.issuer.idp/jwks",
"active" : true,
"createdBy" : "b12c9e14-6079-4d9c-8e4d-cebd1d22d89c",
"createdAt" : {
"nano" : 120276000,
"epochSecond" : 1719915505
},
"deletedAt" : {
"nano" : 129678000,
"epochSecond" : 1719915505
},
"deletedBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"deleted" : true
}
OIDC Public Clients
Find Oidc Public Clients
GET /oidc-public-clients
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJXMWlWd3RYY0FsMFpha0VBbkk5TU1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3
[ ]
Get Oidc Public Client
GET /oidc-public-clients/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/7563e2ec-1338-48e1-984b-c4dc654422f9' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJXMWlWd3RYY0FsMFpha0VBbkk5TU1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776
{
"id" : "7563e2ec-1338-48e1-984b-c4dc654422f9",
"oidcIssuerId" : "6c18c9bf-09f3-43b0-b46f-81d2b87e7b86",
"clientId" : "clientId-cbefb17a-7128-48bd-909c-eb9fcd5385aa",
"clientSecret" : "clientSecret-f2a3dddd-583c-428a-b594-9cc5224e1b12",
"authorizationEndpoint" : "https://4ba4347a-7386-4463-bfa1-5e353e200de1.issuer.idp/authorize",
"tokenEndpoint" : "https://4ba4347a-7386-4463-bfa1-5e353e200de1.issuer.idp/token",
"userInfoEndpoint" : "https://4ba4347a-7386-4463-bfa1-5e353e200de1.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "12658b29-1bed-47cf-bda9-218d8ae5b3e5",
"createdAt" : {
"nano" : 247491000,
"epochSecond" : 1719915499
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Public Client
POST /oidc-public-clients
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJXMWlWd3RYY0FsMFpha0VBbkk5TU1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"oidcIssuerId":"99d4a49a-b952-4165-a10d-2c62b759b120","clientId":"clientId-877548da-62a0-4559-9be3-f52e63abaa7c","clientSecret":"clientSecret-c60a2d9a-fe46-4e69-bd06-c6ab47f7e883","authorizationEndpoint":"https://50b62d2f-d7ac-40f6-99dd-bd2c0855af9b.issuer.idp/authorize","tokenEndpoint":"https://50b62d2f-d7ac-40f6-99dd-bd2c0855af9b.issuer.idp/token","userInfoEndpoint":"https://50b62d2f-d7ac-40f6-99dd-bd2c0855af9b.issuer.idp/userinfo","restrictedToOrganizationIds":[],"active":true}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 776
{
"id" : "b49998fe-e9fe-437d-a981-ac20d467b523",
"oidcIssuerId" : "99d4a49a-b952-4165-a10d-2c62b759b120",
"clientId" : "clientId-877548da-62a0-4559-9be3-f52e63abaa7c",
"clientSecret" : "clientSecret-c60a2d9a-fe46-4e69-bd06-c6ab47f7e883",
"authorizationEndpoint" : "https://50b62d2f-d7ac-40f6-99dd-bd2c0855af9b.issuer.idp/authorize",
"tokenEndpoint" : "https://50b62d2f-d7ac-40f6-99dd-bd2c0855af9b.issuer.idp/token",
"userInfoEndpoint" : "https://50b62d2f-d7ac-40f6-99dd-bd2c0855af9b.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 207184000,
"epochSecond" : 1719915499
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Public Client
PATCH /oidc-public-clients/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/65111439-c46b-4c1d-b181-dead7c8fef1a' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJXMWlWd3RYY0FsMFpha0VBbkk5TU1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"clientId":"clientId-0294d40b-9371-445c-9061-179136185810","clientSecret":"clientSecret-eda89724-6e40-4394-a685-1fce328864cc","authorizationEndpoint":"https://dfd11212-a83c-4919-93c8-e911c81e8045.issuer.idp/authorize","tokenEndpoint":"https://dfd11212-a83c-4919-93c8-e911c81e8045.issuer.idp/token","userInfoEndpoint":"https://dfd11212-a83c-4919-93c8-e911c81e8045.issuer.idp/userinfo","restrictedToOrganizationIds":[],"active":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776
{
"id" : "65111439-c46b-4c1d-b181-dead7c8fef1a",
"oidcIssuerId" : "663d8353-20f5-45a9-b2c6-815f79334fe6",
"clientId" : "clientId-0294d40b-9371-445c-9061-179136185810",
"clientSecret" : "clientSecret-eda89724-6e40-4394-a685-1fce328864cc",
"authorizationEndpoint" : "https://dfd11212-a83c-4919-93c8-e911c81e8045.issuer.idp/authorize",
"tokenEndpoint" : "https://dfd11212-a83c-4919-93c8-e911c81e8045.issuer.idp/token",
"userInfoEndpoint" : "https://dfd11212-a83c-4919-93c8-e911c81e8045.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "044d262a-d42c-47f6-b422-dab783364d39",
"createdAt" : {
"nano" : 72341000,
"epochSecond" : 1719915499
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Public Client
DELETE /oidc-public-clients/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/f12a0d5a-556d-4c79-892a-3699c134d63b' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJXMWlWd3RYY0FsMFpha0VBbkk5TU1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 865
{
"id" : "f12a0d5a-556d-4c79-892a-3699c134d63b",
"oidcIssuerId" : "d12a80da-2850-47df-b9fd-2f297437ed1a",
"clientId" : "clientId-b479b877-31a8-42fe-840f-820e3274b58d",
"clientSecret" : "clientSecret-a9c86dbe-60a1-41fb-b3a3-126761c84d31",
"authorizationEndpoint" : "https://ca622bfb-763e-4f8a-91c1-7430bbc03e1f.issuer.idp/authorize",
"tokenEndpoint" : "https://ca622bfb-763e-4f8a-91c1-7430bbc03e1f.issuer.idp/token",
"userInfoEndpoint" : "https://ca622bfb-763e-4f8a-91c1-7430bbc03e1f.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "1858217b-4a44-4bb5-9afb-92a568c16cfe",
"createdAt" : {
"nano" : 289038000,
"epochSecond" : 1719915499
},
"deletedAt" : {
"nano" : 297964000,
"epochSecond" : 1719915499
},
"deletedBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"deleted" : true
}
Organization to OIDC Public Client Mappings
Find Organization Oidc Public Client Mappings
GET /organization-oidc-public-client-mappings
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
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 |
|
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJoMUltc3JDY1U2Q3FNUEZCVENfOEdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3
[ ]
Get Organization Oidc Public Client Mapping
GET /organization-oidc-public-client-mappings/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
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/organization-oidc-public-client-mappings/c3649614-5403-4532-a2ed-5d74a9841c09' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJoMUltc3JDY1U2Q3FNUEZCVENfOEdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 461
{
"id" : "c3649614-5403-4532-a2ed-5d74a9841c09",
"organizationId" : "282a4a20-397b-4d70-ba2a-60ea9ba37785",
"oidcPublicClientId" : "1ee64968-629a-4312-b71a-fb0d4b49a0d7",
"name" : "console-client-adda0e5e-587d-495e-8147-a7eb6c04b2c7",
"active" : true,
"createdBy" : "14833f84-dd44-49ba-b633-e7a906784aee",
"createdAt" : {
"nano" : 226033000,
"epochSecond" : 1719915504
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Organization Oidc Public Client Mapping
POST /organization-oidc-public-client-mappings
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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 |
|
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJoMUltc3JDY1U2Q3FNUEZCVENfOEdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"organizationId":"11f8e6ae-73ff-4b5c-b89b-f04a8f69f211","oidcPublicClientId":"c5fdceac-797a-4d8e-a020-c4bcf5cafe32","name":"console-client-bfe1ecfe-fa61-4d5d-b336-bd11e89c8164","active":true}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 461
{
"id" : "c76a84ce-c060-4dfc-bcd5-dc70f62f5570",
"organizationId" : "11f8e6ae-73ff-4b5c-b89b-f04a8f69f211",
"oidcPublicClientId" : "c5fdceac-797a-4d8e-a020-c4bcf5cafe32",
"name" : "console-client-bfe1ecfe-fa61-4d5d-b336-bd11e89c8164",
"active" : true,
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 169554000,
"epochSecond" : 1719915504
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Organization Oidc Public Client Mapping
PATCH /organization-oidc-public-client-mappings/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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 |
|
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/21f6d642-a3d9-435b-b80d-63303f699257' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJoMUltc3JDY1U2Q3FNUEZCVENfOEdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"name":"custom-client-d87c8ef7-01d5-4305-9a3e-15a8bb4e55ef","active":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 460
{
"id" : "21f6d642-a3d9-435b-b80d-63303f699257",
"organizationId" : "40ebb994-1db0-46fc-abd6-18850684350b",
"oidcPublicClientId" : "5d9de11b-073f-4b28-875e-4678f6d7f4a3",
"name" : "custom-client-d87c8ef7-01d5-4305-9a3e-15a8bb4e55ef",
"active" : false,
"createdBy" : "261928eb-e07a-4631-803f-8a1244847dcd",
"createdAt" : {
"nano" : 50013000,
"epochSecond" : 1719915504
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Organization Oidc Public Client Mapping
DELETE /organization-oidc-public-client-mappings/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
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/organization-oidc-public-client-mappings/df0bcb80-9dac-4053-bd73-f4d27c9da1b1' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJoMUltc3JDY1U2Q3FNUEZCVENfOEdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 550
{
"id" : "df0bcb80-9dac-4053-bd73-f4d27c9da1b1",
"organizationId" : "c1c4a674-c8e4-459e-b055-5c896b51d079",
"oidcPublicClientId" : "2e03ee9f-dbd2-4c95-937c-8b5a570cc781",
"name" : "console-client-a644fd21-fe40-4043-a977-3e4c13c73dc4",
"active" : true,
"createdBy" : "78da5883-530d-4b66-940f-7b13d3d133a2",
"createdAt" : {
"nano" : 303246000,
"epochSecond" : 1719915504
},
"deletedAt" : {
"nano" : 316961000,
"epochSecond" : 1719915504
},
"deletedBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"deleted" : true
}
OIDC Audiences
Find Oidc Audiences
GET /oidc-audiences
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJFXzhsRGJwNmdHOHV2OHBqTDBZa1RBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk2LCJleHAiOjE3MTk5MTkwOTYsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3
[ ]
Get Oidc Audience
GET /oidc-audiences/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/3f3200d8-8e29-4f35-b607-a77113a3a1ed' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJFXzhsRGJwNmdHOHV2OHBqTDBZa1RBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk2LCJleHAiOjE3MTk5MTkwOTYsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430
{
"id" : "3f3200d8-8e29-4f35-b607-a77113a3a1ed",
"oidcIssuerId" : "7eb90dfe-7bcf-4f02-8aaa-e4c40c9e0d88",
"audience" : "mop-aud-22eee68c-632c-406e-8866-d1384f1a2dd6",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "232929f3-eee2-4811-b297-fd0d94425084",
"createdAt" : {
"nano" : 204838000,
"epochSecond" : 1719915497
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Audience
POST /oidc-audiences
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJFXzhsRGJwNmdHOHV2OHBqTDBZa1RBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk2LCJleHAiOjE3MTk5MTkwOTYsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"oidcIssuerId":"41d37ac2-0324-42ba-b37f-2d6ce542bf78","audience":"mop-aud-cb1150aa-3037-4e11-88f6-bbcf7def2666","restrictedToOrganizationIds":[],"active":true}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "0d8f1f14-6043-44fe-9efb-aab2afdc5f34",
"oidcIssuerId" : "41d37ac2-0324-42ba-b37f-2d6ce542bf78",
"audience" : "mop-aud-cb1150aa-3037-4e11-88f6-bbcf7def2666",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 135073000,
"epochSecond" : 1719915497
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Audience
PATCH /oidc-audiences/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/d86f0dfb-5a0b-47d6-89bf-d9b6783125ba' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJFXzhsRGJwNmdHOHV2OHBqTDBZa1RBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk2LCJleHAiOjE3MTk5MTkwOTYsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"audience":"mop-aud-85505274-51e1-440a-b6ee-9658c12c3138","restrictedToOrganizationIds":[],"active":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "d86f0dfb-5a0b-47d6-89bf-d9b6783125ba",
"oidcIssuerId" : "119e3f6e-af67-44a6-85f8-d48fcad85055",
"audience" : "mop-aud-85505274-51e1-440a-b6ee-9658c12c3138",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "659fe5e7-27bd-45a2-8a14-9fa07afca9d6",
"createdAt" : {
"nano" : 837698000,
"epochSecond" : 1719915496
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Audience
DELETE /oidc-audiences/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/7ad82082-9b7e-4dc4-ad2d-443cdfe3862b' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJFXzhsRGJwNmdHOHV2OHBqTDBZa1RBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk2LCJleHAiOjE3MTk5MTkwOTYsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 519
{
"id" : "7ad82082-9b7e-4dc4-ad2d-443cdfe3862b",
"oidcIssuerId" : "279b989f-c54b-4ab7-beee-dc6b8aa0b4be",
"audience" : "mop-aud-6a28b548-73c6-4180-92c7-a25acde19d2b",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "3985f077-a656-4b6d-becf-e3e713634e58",
"createdAt" : {
"nano" : 294474000,
"epochSecond" : 1719915497
},
"deletedAt" : {
"nano" : 306759000,
"epochSecond" : 1719915497
},
"deletedBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"deleted" : true
}
User Identity to OIDC Audience Mappings
Find User Identity Audience Mappings
GET /user-identity-oidc-audience-mappings
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJBak10cU1sU0h3elNsSGZ6ekpIODZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
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
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/45bf7a8f-2a0c-4306-9b15-e6435876302c' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJBak10cU1sU0h3elNsSGZ6ekpIODZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 460
{
"id" : "45bf7a8f-2a0c-4306-9b15-e6435876302c",
"userIdentityId" : "20685330-777b-4311-a73b-5de5f1a7b655",
"oidcAudienceId" : "c13bfe79-1ac7-461b-907e-d6a6f706af19",
"subject" : "console-client-2c5bab7a-51a4-4007-96a6-4127c01e22a6",
"active" : true,
"createdBy" : "e0ca7e81-b44d-4b9f-a067-78ad7d30214a",
"createdAt" : {
"nano" : 261494000,
"epochSecond" : 1719915501
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create User Identity Audience Mapping
POST /user-identity-oidc-audience-mappings
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJBak10cU1sU0h3elNsSGZ6ekpIODZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"userIdentityId":"5c4d3f49-b89e-4f1d-9b1b-54fbac9dcb60","oidcAudienceId":"066d58fe-fef7-4e28-96ff-7d47b1f126b9","subject":"console-client-849a217c-6735-4bbc-a60f-dd5141e07b6a","active":true}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 460
{
"id" : "ae3a264e-d242-434e-8f64-c8d65fbfae7c",
"userIdentityId" : "5c4d3f49-b89e-4f1d-9b1b-54fbac9dcb60",
"oidcAudienceId" : "066d58fe-fef7-4e28-96ff-7d47b1f126b9",
"subject" : "console-client-849a217c-6735-4bbc-a60f-dd5141e07b6a",
"active" : true,
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 217157000,
"epochSecond" : 1719915501
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update User Identity Audience Mapping
PATCH /user-identity-oidc-audience-mappings/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/61ac84d9-b55d-4971-b3eb-4831aaf4dadc' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJBak10cU1sU0h3elNsSGZ6ekpIODZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"active":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 461
{
"id" : "61ac84d9-b55d-4971-b3eb-4831aaf4dadc",
"userIdentityId" : "e3fff66b-200e-43b3-8f57-7045c0fa1dec",
"oidcAudienceId" : "9ff616bd-7ba3-4374-b2db-f393269b22bf",
"subject" : "console-client-d86a065c-bc26-42b8-a940-447201e15a63",
"active" : false,
"createdBy" : "ca58c37b-75ee-4389-b0c4-2b968be7c3f6",
"createdAt" : {
"nano" : 103289000,
"epochSecond" : 1719915501
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete User Identity Audience Mapping
DELETE /user-identity-oidc-audience-mappings/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/af076c4c-0ef9-4355-b935-22586bcec503' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJBak10cU1sU0h3elNsSGZ6ekpIODZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAxLCJleHAiOjE3MTk5MTkxMDEsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 549
{
"id" : "af076c4c-0ef9-4355-b935-22586bcec503",
"userIdentityId" : "40a7d053-e16d-4208-b768-229ff5f52549",
"oidcAudienceId" : "ca66e56c-12d1-4f15-8a8f-460e68bdf4f2",
"subject" : "console-client-47d6c868-1a36-45e1-9bac-24789261cf93",
"active" : true,
"createdBy" : "2dda8d29-8e9f-401f-992f-a361d542ecf4",
"createdAt" : {
"nano" : 306047000,
"epochSecond" : 1719915501
},
"deletedAt" : {
"nano" : 315433000,
"epochSecond" : 1719915501
},
"deletedBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"deleted" : true
}
Identity Providers
Find Identity Providers
GET /identity-providers
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
organizationId |
Object |
true |
|
auth0ConnectionId |
Object |
true |
|
auth0ConnectionType |
Object |
true |
|
active |
Boolean |
true |
|
deleted |
Object |
true |
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJwVjVXS0ZQWFNCYk91ekJ4cUd4b1VBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1127
[ {
"id" : "076f78e6-ecb0-466c-a7f3-f7260a8eded4",
"organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
"auth0ConnectionId" : "google-oauth2",
"name" : "NetFoundry Google Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 476622000,
"epochSecond" : 1719915452
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "08fc7c7e-9140-470d-8add-7721fc2119a1",
"organizationId" : "40a1d0fe-faf3-49db-9029-f31f9c4d5d07",
"auth0ConnectionId" : "auth0-opaque-connectionId-189",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 500570000,
"epochSecond" : 1719915504
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "15ea15fd-53e2-48e9-86d2-e29a0dc80328",
"organizationId" : "5ea83fd7-e38f-4d2a-ae21-98a37ee7f0ff",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Best Corp.",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 430837000,
"epochSecond" : 1719915501
},
"updatedAt" : null,
"deletedAt" : null
} ]
Get Identity Provider
GET /identity-providers/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/8f338bdd-c895-462a-bd7a-3adb3be6e545' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJwVjVXS0ZQWFNCYk91ekJ4cUd4b1VBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 373
{
"id" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ConnectionId" : "auth0-opaque-connectionId-2",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 845636000,
"epochSecond" : 1719915456
},
"updatedAt" : null,
"deletedAt" : null
}
Create Identity Provider
POST /identity-providers
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJwVjVXS0ZQWFNCYk91ekJ4cUd4b1VBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"organizationId":"40a1d0fe-faf3-49db-9029-f31f9c4d5d07","auth0ConnectionId":"auth0-opaque-connection","name":"Corp SAML","auth0ConnectionType":"Enterprise"}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 368
{
"id" : "f1b0199c-0632-4a79-843c-20c07689f2fa",
"organizationId" : "40a1d0fe-faf3-49db-9029-f31f9c4d5d07",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 525784000,
"epochSecond" : 1719915504
},
"updatedAt" : null,
"deletedAt" : null
}
Update Identity Provider
PUT /identity-providers/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/5be76bdc-3860-4882-b4e0-71e796b9242f' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJwVjVXS0ZQWFNCYk91ekJ4cUd4b1VBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"name":"New IdP Name"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "5be76bdc-3860-4882-b4e0-71e796b9242f",
"organizationId" : "b543815a-f1fc-4469-a271-f57e3a8fb084",
"auth0ConnectionId" : "auth0-opaque-connectionId-195",
"name" : "New IdP Name",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 796766000,
"epochSecond" : 1719915504
},
"updatedAt" : {
"nano" : 823469000,
"epochSecond" : 1719915504
},
"deletedAt" : null
}
Activate Or Deactivate Identity Provider
PUT /identity-providers/{id}/{action:activate|deactivate}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
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/95190e26-bf65-402b-8c1e-175ae1ce513e/activate' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJwVjVXS0ZQWFNCYk91ekJ4cUd4b1VBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "95190e26-bf65-402b-8c1e-175ae1ce513e",
"organizationId" : "a432caa3-810a-4a01-89d5-867c581a7e8b",
"auth0ConnectionId" : "auth0-opaque-connectionId-191",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 616751000,
"epochSecond" : 1719915504
},
"updatedAt" : null,
"deletedAt" : null
}
Delete Identity Provider
DELETE /identity-providers/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/c619a666-de42-40f5-8306-5cd862b49f59' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJwVjVXS0ZQWFNCYk91ekJ4cUd4b1VBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA0LCJleHAiOjE3MTk5MTkxMDQsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "c619a666-de42-40f5-8306-5cd862b49f59",
"organizationId" : "70ef244d-3980-46d0-a1a8-6b018f66e440",
"auth0ConnectionId" : "auth0-opaque-connectionId-193",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 728993000,
"epochSecond" : 1719915504
},
"updatedAt" : {
"nano" : 748909000,
"epochSecond" : 1719915504
},
"deletedAt" : {
"nano" : 748000000,
"epochSecond" : 1719915504
}
}
Default Roles
Find Default Roles
GET /default-roles
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJDRW81dmdWTGxaY1pOR0V5SVhtVzdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAyLCJleHAiOjE3MTk5MTkxMDIsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1318
[ {
"id" : "023c1949-7cca-45fb-83ad-2b8d9b129b20",
"organizationId" : "46c809e8-f601-4e60-ac79-57ca74a30e32",
"name" : "Default Standard Role-118",
"roleType" : "Standard",
"roleId" : "fca666f9-4cba-4218-90b0-6caa774d3af8",
"createdBy" : "0799bcd4-36bd-4cf5-a3ad-232bc9900657",
"createdAt" : {
"nano" : 514051000,
"epochSecond" : 1719915502
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "0ac23b2a-5929-4766-938f-eb5c7fd49df3",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Custom Role",
"roleType" : "Custom",
"roleId" : "8448a717-9950-48c4-9033-c2315f92e9de",
"createdBy" : "e0d21733-b04d-4cf2-b888-6aaf0da9edcd",
"createdAt" : {
"nano" : 860581000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "16ad9912-a087-4498-9015-2a6b1318d643",
"organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
"name" : "Network Group Admin - Cloud Engineering Network Group",
"roleType" : "Standard",
"roleId" : "b75be358-a3f9-40a5-972d-a804c4758041",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 478847000,
"epochSecond" : 1719915452
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Default Role
GET /default-roles/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/1e7f459d-cf0b-48fd-b24c-f354805f6f02' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJDRW81dmdWTGxaY1pOR0V5SVhtVzdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAyLCJleHAiOjE3MTk5MTkxMDIsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 419
{
"id" : "1e7f459d-cf0b-48fd-b24c-f354805f6f02",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Std Role",
"roleType" : "Standard",
"roleId" : "e0f28edf-cef0-4fc5-8b80-1fc7cdb5acb1",
"createdBy" : "1c1fc1cb-b575-4c9e-8bd3-6cd11aa002b0",
"createdAt" : {
"nano" : 849911000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Default Role
POST /default-roles
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJDRW81dmdWTGxaY1pOR0V5SVhtVzdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAyLCJleHAiOjE3MTk5MTkxMDIsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"organizationId":"c2a53715-3cd6-4c78-8437-65d95c5b04d2","roleType":"Standard","roleId":"b9abaadf-534d-4d7f-b6ae-28f79ef0c8df"}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 458
{
"id" : "2f54551c-1abe-4caa-96ba-182658056d97",
"organizationId" : "c2a53715-3cd6-4c78-8437-65d95c5b04d2",
"name" : "Standard Role - b9abaadf-534d-4d7f-b6ae-28f79ef0c8df",
"roleType" : "Standard",
"roleId" : "b9abaadf-534d-4d7f-b6ae-28f79ef0c8df",
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 932512000,
"epochSecond" : 1719915502
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Default Role
DELETE /default-roles/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/e75bb6ce-a942-41ae-af9c-5b03eb2d5ac3' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJDRW81dmdWTGxaY1pOR0V5SVhtVzdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAyLCJleHAiOjE3MTk5MTkxMDIsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "e75bb6ce-a942-41ae-af9c-5b03eb2d5ac3",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"name" : "Test Deletion",
"roleType" : "Standard",
"roleId" : "ac5488b0-12f0-49a5-a87a-3b5f6a43a1f5",
"createdBy" : "e80f01c6-bfaf-43a3-a994-623068cbfd4c",
"createdAt" : {
"nano" : 770525000,
"epochSecond" : 1719915502
},
"deletedAt" : {
"nano" : 778000000,
"epochSecond" : 1719915502
},
"deletedBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"deleted" : true
}
Grant Default Role
POST /default-roles/{id}/grant
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles/023c1949-7cca-45fb-83ad-2b8d9b129b20/grant' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJDRW81dmdWTGxaY1pOR0V5SVhtVzdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAyLCJleHAiOjE3MTk5MTkxMDIsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"includeIdentityIds":["faaedf06-9d82-4f2d-8d45-ce184a251167","908fece0-471f-4481-b72c-8cb052b8278c","310ace31-6819-49ff-bd2a-1a65f94f1f59"],"excludeIdentityIds":["57c037bf-bd45-4230-bdbc-025175272c64","908fece0-471f-4481-b72c-8cb052b8278c","310ace31-6819-49ff-bd2a-1a65f94f1f59"]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51
{
"faaedf06-9d82-4f2d-8d45-ce184a251167" : true
}
User Identity
Get Identity
GET /identities/self
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
id |
String |
true |
|
type |
String |
true |
|
active |
Boolean |
true |
|
deletedAt |
Object |
true |
|
createdAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
organizationId |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identities/self' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 727
{
"id" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "TESTING",
"lastName" : "CLIENT",
"email" : "test.client@server.com",
"identityMappings" : [ {
"id" : "10792aae-0a45-4be6-9131-03328ae02893",
"auth0UserId" : "auth0-opaque-userId-6",
"identityProviderId" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"userIdentityId" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 973859000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"name" : "TESTING CLIENT",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"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}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
|
id |
String |
true |
|
type |
String |
true |
|
active |
Boolean |
true |
|
deletedAt |
Object |
true |
|
createdAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
organizationId |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identities/e7e673ad-59f5-44ec-a217-dbca9d249606' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "e7e673ad-59f5-44ec-a217-dbca9d249606",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "d2ede38c-1ea9-4e2a-9794-eb38757b8311",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "c666343e-9631-41cb-be7d-49bbac97b317",
"userIdentityId" : "e7e673ad-59f5-44ec-a217-dbca9d249606"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 927172000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "UserIdentity"
}
Find User Identities
GET /user-identities
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2394
[ {
"id" : "01a489c2-94f7-45cd-9d97-156d2d142d4a",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-35@acme.com",
"identityMappings" : [ {
"id" : "8f4e1545-a5e9-4de5-8e8a-696e6d1c85e0",
"auth0UserId" : "new-auth0-userId",
"identityProviderId" : "c666343e-9631-41cb-be7d-49bbac97b317",
"userIdentityId" : "01a489c2-94f7-45cd-9d97-156d2d142d4a"
}, {
"id" : "ba6f4154-c382-49e6-a592-fff29f8b44ab",
"auth0UserId" : "auth0-opaque-userId-36",
"identityProviderId" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"userIdentityId" : "01a489c2-94f7-45cd-9d97-156d2d142d4a"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 719896000,
"epochSecond" : 1719915497
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "UserIdentity"
}, {
"id" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "TESTING",
"lastName" : "CLIENT",
"email" : "test.client@server.com",
"identityMappings" : [ {
"id" : "10792aae-0a45-4be6-9131-03328ae02893",
"auth0UserId" : "auth0-opaque-userId-6",
"identityProviderId" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"userIdentityId" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 973859000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"name" : "TESTING CLIENT",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "UserIdentity"
}, {
"id" : "0e5ad97a-21d6-4eac-a867-c1e3ce9e58cb",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-60@acme.com",
"identityMappings" : [ {
"id" : "980a5c57-1532-4cb7-9f5b-9d1d5f8c3993",
"auth0UserId" : "auth0-opaque-userId-61",
"identityProviderId" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"userIdentityId" : "0e5ad97a-21d6-4eac-a867-c1e3ce9e58cb"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 779211000,
"epochSecond" : 1719915498
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"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}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/e7e673ad-59f5-44ec-a217-dbca9d249606' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "e7e673ad-59f5-44ec-a217-dbca9d249606",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "d2ede38c-1ea9-4e2a-9794-eb38757b8311",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "c666343e-9631-41cb-be7d-49bbac97b317",
"userIdentityId" : "e7e673ad-59f5-44ec-a217-dbca9d249606"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 927172000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "UserIdentity"
}
Get User Identity By Mapping
GET /user-identities/mapping/{auth0UserId}/{identityProviderId}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
auth0UserId |
String |
false |
|
identityProviderId |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/mapping/auth0-opaque-userId-3/c666343e-9631-41cb-be7d-49bbac97b317' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 710
{
"id" : "e7e673ad-59f5-44ec-a217-dbca9d249606",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "d2ede38c-1ea9-4e2a-9794-eb38757b8311",
"auth0UserId" : "auth0-opaque-userId-3",
"identityProviderId" : "c666343e-9631-41cb-be7d-49bbac97b317",
"userIdentityId" : "e7e673ad-59f5-44ec-a217-dbca9d249606"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 927172000,
"epochSecond" : 1719915456
},
"deletedAt" : null,
"name" : "John Doe",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "UserIdentity"
}
Create Identity
POST /user-identities
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"organizationId":"5947bad8-cab0-437d-a061-b1e498584f3f","firstName":"Jane","lastName":"Doe","email":"jane.doe@acme.com"}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 479
{
"id" : "2fb34c2d-2f97-48d5-a635-a65ce1be68f3",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com",
"identityMappings" : [ ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 360844000,
"epochSecond" : 1719915500
},
"deletedAt" : null,
"name" : "Jane Doe",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "UserIdentity"
}
Update Identity Info
PUT /user-identities/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/cf21e596-15f1-454a-8ded-106f2ef6f398' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"firstName":"Bobby","lastName":"White","email":"bobby.white@acme.com"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 720
{
"id" : "cf21e596-15f1-454a-8ded-106f2ef6f398",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com",
"identityMappings" : [ {
"id" : "a7994c8c-9187-4eb8-9f1e-6d58076ed8be",
"auth0UserId" : "auth0-opaque-userId-73",
"identityProviderId" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"userIdentityId" : "cf21e596-15f1-454a-8ded-106f2ef6f398"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 672190000,
"epochSecond" : 1719915499
},
"deletedAt" : null,
"name" : "Bobby White",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "UserIdentity"
}
Activate Or Deactivate User Identity
PUT /user-identities/{id}/{action:activate|deactivate}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
name |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/f48fea18-c560-4f0a-baff-c483f31fbdff/deactivate' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 717
{
"id" : "f48fea18-c560-4f0a-baff-c483f31fbdff",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-74@acme.com",
"identityMappings" : [ {
"id" : "ab52dc84-1a78-4f6d-b863-2f6256123011",
"auth0UserId" : "auth0-opaque-userId-75",
"identityProviderId" : "8f338bdd-c895-462a-bd7a-3adb3be6e545",
"userIdentityId" : "f48fea18-c560-4f0a-baff-c483f31fbdff"
} ],
"identityAudienceMappings" : [ ],
"active" : false,
"createdAt" : {
"nano" : 774933000,
"epochSecond" : 1719915499
},
"deletedAt" : null,
"name" : "First Last",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "UserIdentity"
}
Reset User Identity Mfa Settings
PUT /user-identities/{id}/reset-mfa
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/d5deee0c-dd3a-4b18-b511-6b99af0544fe/reset-mfa' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Map Identity
POST /user-identities/{id}/mapping
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/bb64e21f-76e9-4396-a728-e3b10a6dc5bd/mapping' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiI1R1BBZ2czLXBueTduV2o3Z0lRR0x3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk5LCJleHAiOjE3MTk5MTkwOTksInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"auth0UserId":"new-auth0-userId:25253d94-536a-44df-97a9-03ebb22b216f","identityProviderId":"c666343e-9631-41cb-be7d-49bbac97b317"}'
Example response
HTTP/1.1 200 OK
API Account Identity
Find Api Account Identities
GET /api-account-identities
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
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]. |
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJpem42ZmJycWJCdWZmZEtOZmZERnR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDU3LCJleHAiOjE3MTk5MTkwNTcsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2006
[ {
"id" : "188d0ceb-ef0f-4b23-8d39-06578c41cb8f",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ClientId" : null,
"awsCognitoClientId" : "6c488f75-c24e-4228-b48d-756f5adf8410|khshssmb",
"authenticationUrl" : "https://netfoundry-test-yvdkpl.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 793883000,
"epochSecond" : 1719915482
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "ApiAccountIdentity"
}, {
"id" : "1cd8aa59-4693-4c2f-9f5c-2a6cabdbdd4a",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ClientId" : null,
"awsCognitoClientId" : "b686eab4-f72a-4b3b-b8a3-6047bad0cd5b|wxpoeoix",
"authenticationUrl" : "https://netfoundry-test-eswcsd.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 173797000,
"epochSecond" : 1719915472
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "ApiAccountIdentity"
}, {
"id" : "1eb1ed60-2082-4c98-bc23-50f0d986e42b",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ClientId" : null,
"awsCognitoClientId" : "63984d1a-e7ba-45b1-bbe6-98d60e9c6c88|qqgxloyo",
"authenticationUrl" : "https://netfoundry-test-avgsoe.auth.us-east-1.amazoncognito.com/oauth2/token",
"name" : "Testing Limits",
"contactEmail" : "a@acme.com",
"description" : "description",
"active" : true,
"createdAt" : {
"nano" : 110793000,
"epochSecond" : 1719915485
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "a@acme.com",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"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}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/20052b79-e4cc-4fc7-a3ee-614accf4ff62' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJpem42ZmJycWJCdWZmZEtOZmZERnR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDU3LCJleHAiOjE3MTk5MTkwNTcsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 718
{
"id" : "20052b79-e4cc-4fc7-a3ee-614accf4ff62",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ClientId" : "77c3e7b0-0aa2-4fbd-866a-465c595bc4d2",
"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" : 945371000,
"epochSecond" : 1719915456
},
"updatedAt" : {
"nano" : 623602000,
"epochSecond" : 1719915458
},
"deletedAt" : null,
"email" : "no-reply@acme.com",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "ApiAccountIdentity"
}
Get Api Account Identity By Mapping
GET /api-account-identities/mapping/{clientId}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
clientId |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
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/9c402d47-5ff5-4557-905a-f4ff76ba061f' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJpem42ZmJycWJCdWZmZEtOZmZERnR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDU3LCJleHAiOjE3MTk5MTkwNTcsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 682
{
"id" : "987aae6b-f87e-4f1f-a3d3-f309dafd2940",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ClientId" : "9c402d47-5ff5-4557-905a-f4ff76ba061f",
"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" : 450991000,
"epochSecond" : 1719915496
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "service.admin-30@foo.com",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "ApiAccountIdentity"
}
Create Api Account Identity
POST /api-account-identities
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJpem42ZmJycWJCdWZmZEtOZmZERnR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDU3LCJleHAiOjE3MTk5MTkwNTcsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"organizationId":"5947bad8-cab0-437d-a061-b1e498584f3f","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: 939
{
"apiAccountIdentity" : {
"id" : "bfcf7803-6757-44fa-b7c4-16ca79cf8ee8",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ClientId" : null,
"awsCognitoClientId" : "d949d83d-e84c-4093-b562-29cbdf7f9605|xndvmqdf",
"authenticationUrl" : "https://netfoundry-test-uomyog.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" : 65665000,
"epochSecond" : 1719915462
},
"updatedAt" : null,
"deletedAt" : null,
"email" : "hr.director@acme.com",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "ApiAccountIdentity"
},
"clientId" : "xndvmqdf",
"password" : "cciwklkxxonvdbsxgkiwrhep",
"authenticationUrl" : "https://netfoundry-test-uomyog.auth.us-east-1.amazoncognito.com/oauth2/token"
}
Update Identity Info
PUT /api-account-identities/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/d962e72a-9440-4212-a722-38db4d3529ae' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJpem42ZmJycWJCdWZmZEtOZmZERnR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDU3LCJleHAiOjE3MTk5MTkwNTcsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-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" : "d962e72a-9440-4212-a722-38db4d3529ae",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ClientId" : "679ff7ee-68a7-44c2-ab07-9056cf2c5067",
"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" : 992973000,
"epochSecond" : 1719915456
},
"updatedAt" : {
"nano" : 720093000,
"epochSecond" : 1719915457
},
"deletedAt" : null,
"email" : "robot@acme.com",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "ApiAccountIdentity"
}
Activate Or Deactivate Api Account Identity
PUT /api-account-identities/{id}/{action:activate|deactivate}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
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/86f5a78e-75ad-4f9b-93d1-5e39f0bce925/deactivate' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJpem42ZmJycWJCdWZmZEtOZmZERnR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDU3LCJleHAiOjE3MTk5MTkwNTcsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 739
{
"id" : "86f5a78e-75ad-4f9b-93d1-5e39f0bce925",
"organizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"auth0ClientId" : "79277b87-f483-47bf-8cd8-02275c630aa0",
"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" : 332309000,
"epochSecond" : 1719915496
},
"updatedAt" : {
"nano" : 350625000,
"epochSecond" : 1719915496
},
"deletedAt" : null,
"email" : "service.admin-24@foo.com",
"tenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"type" : "ApiAccountIdentity"
}
Invitation
Find Invitations
GET /invitations
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
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 |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJsbWJfXzBQWGdWWE5vblBHanEyRURnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA1LCJleHAiOjE3MTk5MTkxMDUsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJjMmQ5MjNjNS1kMGIwLTQ2YWYtOGI0Ny01MjdmYzk0ZDI5MDRcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDV9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1644
[ {
"id" : "15e0f0f7-17db-4a69-be24-ffa9c1e9ff2d",
"fromIdentityId" : "e7e673ad-59f5-44ec-a217-dbca9d249606",
"toOrganizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"invitedEmailAddress" : "new.employee-85@acme.com",
"expiration" : {
"nano" : 864506000,
"epochSecond" : 1720520300
},
"targetUserIdentityId" : "fc31821e-941a-470a-9dc8-e118406984e0",
"accepted" : false,
"revokedAt" : null,
"responseReceivedAt" : {
"nano" : 872482000,
"epochSecond" : 1719915500
},
"state" : "Declined",
"toTenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f"
}, {
"id" : "4d839d90-afbe-4efe-82ff-69aa17d354fd",
"fromIdentityId" : "e7e673ad-59f5-44ec-a217-dbca9d249606",
"toOrganizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"invitedEmailAddress" : "new.employee-82@acme.com",
"expiration" : {
"nano" : 777913000,
"epochSecond" : 1720520300
},
"targetUserIdentityId" : "ef08ce4e-2b50-46c3-ba28-04c0304b2a8d",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f"
}, {
"id" : "8cffd310-3076-481d-8f59-ff7e26787fb7",
"fromIdentityId" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"toOrganizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 261793000,
"epochSecond" : 1720520305
},
"targetUserIdentityId" : "023c4fdd-2f82-4bc0-b073-e6ca55eeca6d",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f"
} ]
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}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/7eccc79f-321e-4770-8feb-48f4d50f7001' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJsbWJfXzBQWGdWWE5vblBHanEyRURnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA1LCJleHAiOjE3MTk5MTkxMDUsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJjMmQ5MjNjNS1kMGIwLTQ2YWYtOGI0Ny01MjdmYzk0ZDI5MDRcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDV9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 527
{
"id" : "7eccc79f-321e-4770-8feb-48f4d50f7001",
"fromIdentityId" : "e7e673ad-59f5-44ec-a217-dbca9d249606",
"toOrganizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"invitedEmailAddress" : "new.employee-203@acme.com",
"expiration" : {
"nano" : 465626000,
"epochSecond" : 1720520305
},
"targetUserIdentityId" : "a955671d-3304-480b-919e-9cbebf97967e",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f"
}
Create Invitation
POST /invitations
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
invitationUrl |
String |
true |
|
targetUserIdentityId |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJsbWJfXzBQWGdWWE5vblBHanEyRURnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA1LCJleHAiOjE3MTk5MTkxMDUsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJjMmQ5MjNjNS1kMGIwLTQ2YWYtOGI0Ny01MjdmYzk0ZDI5MDRcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDV9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"toOrganizationId":"5947bad8-cab0-437d-a061-b1e498584f3f","invitedEmailAddress":"new.employee@acme.com","invitationUrl":"http://acme.console.netfoundry.io/invitation","targetUserIdentityId":"023c4fdd-2f82-4bc0-b073-e6ca55eeca6d"}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 523
{
"id" : "8cffd310-3076-481d-8f59-ff7e26787fb7",
"fromIdentityId" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"toOrganizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"invitedEmailAddress" : "new.employee@acme.com",
"expiration" : {
"nano" : 261793000,
"epochSecond" : 1720520305
},
"targetUserIdentityId" : "023c4fdd-2f82-4bc0-b073-e6ca55eeca6d",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f"
}
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}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/43d4b4a0-3e3b-4ae7-993f-7e529fd8d8da/decline' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJsbWJfXzBQWGdWWE5vblBHanEyRURnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA1LCJleHAiOjE3MTk5MTkxMDUsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJjMmQ5MjNjNS1kMGIwLTQ2YWYtOGI0Ny01MjdmYzk0ZDI5MDRcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDV9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 588
{
"id" : "43d4b4a0-3e3b-4ae7-993f-7e529fd8d8da",
"fromIdentityId" : "e7e673ad-59f5-44ec-a217-dbca9d249606",
"toOrganizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"invitedEmailAddress" : "new.employee-200@acme.com",
"expiration" : {
"nano" : 420962000,
"epochSecond" : 1720520305
},
"targetUserIdentityId" : "c1ff6405-5227-487a-b0eb-56bb51a1b434",
"accepted" : false,
"revokedAt" : null,
"responseReceivedAt" : {
"nano" : 429974000,
"epochSecond" : 1719915505
},
"state" : "Declined",
"toTenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f"
}
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
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/86e29f86-84bd-4da1-b416-8745de77fbb5/revoke' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJsbWJfXzBQWGdWWE5vblBHanEyRURnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTA1LCJleHAiOjE3MTk5MTkxMDUsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCIwMzBiYTNlOC0wZDRjLTQ1ZGMtOTk1Yi0wMjc4MzNhNzkyYmFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI5NTYzN2QwYy0wMTlkLTRhNzUtODQ5ZC1iYzJhZTkxYjk0MzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDR9LHtcImlkXCI6XCI2YjY1NzA0YS02YWUyLTQ0NTQtODNiYy05MTVhNmQyMjZiZjlcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJjMmQ5MjNjNS1kMGIwLTQ2YWYtOGI0Ny01MjdmYzk0ZDI5MDRcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDV9LHtcImlkXCI6XCI3MDc5NjQ2ZS1hMTgwLTQ1NmItYWYwMy1lZTA5MTk3NjZlYTBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 642
{
"id" : "86e29f86-84bd-4da1-b416-8745de77fbb5",
"fromIdentityId" : "e7e673ad-59f5-44ec-a217-dbca9d249606",
"toOrganizationId" : "5947bad8-cab0-437d-a061-b1e498584f3f",
"invitedEmailAddress" : "new.employee-206@acme.com",
"expiration" : {
"nano" : 512832000,
"epochSecond" : 1720520305
},
"targetUserIdentityId" : "9a838f34-b31c-4c46-a4e6-0f7ec859245e",
"accepted" : null,
"revokedAt" : {
"nano" : 525137000,
"epochSecond" : 1719915505
},
"responseReceivedAt" : {
"nano" : 525142000,
"epochSecond" : 1719915505
},
"state" : "Revoked",
"toTenantId" : "5947bad8-cab0-437d-a061-b1e498584f3f"
}
Support
Create Support Request
POST /nfconsole/support/requests
Authorization
Authorization not required for this request.
Path parameters
No parameters.
Query parameters
No parameters.
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 |
Response fields
No response body.
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 |
Query parameters
No parameters.
Request fields
No request body.
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/0EinKH1nKWEqZmt2gNBJ3meNanybI0a02HyV' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 517
{
"fromIdentity" : {
"name" : "John Doe",
"email" : "john.doe@acme.com"
},
"targetIdentity" : {
"name" : "First Last",
"email" : "random-86@acme.com"
},
"invitedEmailAddress" : "new.employee-88@acme.com",
"toOrganizationName" : "ACME International, Inc.",
"toOrganizationLabel" : "ACME-0",
"expiration" : {
"nano" : 937137000,
"epochSecond" : 1720520300
},
"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 |
Query parameters
No parameters.
Request fields
No request body.
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/7sSddAtvsg9yYf9gjfP5Knd1vk4jL658w2XP/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"fromIdentity" : {
"name" : "John Doe",
"email" : "john.doe@acme.com"
},
"targetIdentity" : {
"name" : "First Last",
"email" : "random-83@acme.com"
},
"invitedEmailAddress" : "new.employee-85@acme.com",
"toOrganizationName" : "ACME International, Inc.",
"toOrganizationLabel" : "ACME-0",
"expiration" : {
"nano" : 864506000,
"epochSecond" : 1720520300
},
"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 |
Query parameters
No parameters.
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/MKbhQHOejv30X9uoP6yi5nqaDkdC1OXKKfP6/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.eyJpYXQiOjE3MTk5MTU1MDAsImV4cCI6MTcxOTkxNjQwMCwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJpbnZpdGF0aW9uIiwiaW52aXRhdGlvbklkIjoiNGQ4MzlkOTAtYWZiZS00ZWZlLTgyZmYtNjlhYTE3ZDM1NGZkIiwidGVuYW50TGFiZWwiOiJBQ01FLTAiLCJhdXRoMENvbm5lY3Rpb25JZHMiOlsiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0yIiwiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0xIl0sInJlZGlyZWN0VXJsIjoiaHR0cDovL2NvbnNvbGUubmZhZG1pbi5uZXRmb3VuZHJ5LmlvL2ludml0YXRpb24ifQ.DDebQUAPX-OmDq8towWkbs0puhL70uStEwP0owP-TSy3otH-fwjOw_on2JNqbuWupIfIe-m-8yIYN7Ug9n7tPcnBjO8LvR4smvnl2HeayshEmtkMt_NQi6l1GGwaXQl_FScXPNXTzZU-DomQCH0JqUo4AVV_xY8O-SBPD3xHljTn6E6W1o4uDl1SxuIFluyGi9q0rgPy8AOCWQ14v1SZjoRfRnXYEiQbaGtTl4tuOt1xD0Ms0lhZxmD0CBUrxXBeL7dxd3tuWq705n3Xvi4SGcHoBzWgKaL1kFVpfQhY19egrp8enrupFRq2-r5yYrD1Y0ONd9eUFRf8ehDXkA-y4Q",
"auth0ConnectionIds" : [ "auth0-opaque-connectionId-2", "auth0-opaque-connectionId-1" ]
}
Login Flow
Initiate Interactive Authorization
POST /organizations/authorize-initiate
Authorization
Authorization not required for this request.
Path parameters
No parameters.
Query parameters
No parameters.
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.eyJpYXQiOjE3MTk5MTU0OTcsImV4cCI6MTcxOTkxNjM5NywiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJsb2dpbiIsInRlbmFudExhYmVsIjoiQUNNRS0wIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMiIsImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMSJdLCJyZWRpcmVjdFVybCI6Imh0dHA6Ly9jb25zb2xlLm5mYWRtaW4ubmV0Zm91bmRyeS5pby9pbnZpdGF0aW9uIn0.UJEo37pf80qFOOJY-VkLSfx0Tn9qhCvmCXuoisNDdfOhRSWF9hvY4i564NSIn4YgmOWV4inlQ2fCPIKNCBA1wTIUgkSV8dcn0OHS0s_nG48NWuhkVlB1ulaJt6QvDgNp6e4P5rqAVZee-UmPi7-WXHtnuh6XLSFtKz_7DIHSrDcYm6eUyrKliferI6d0WDD84mNr8QGEgj-WFv6zG5nc21tb2Y0QPxKgP4pccDvGUE0Ii4sC3DJZoBiQZ1pLG2vfJEeJpuaTPo-L57_h0B9zHXjTmHSpcWyHXvWl3UPoncs3fC2_KEa3QCxQ7pX1Fyb3hnUnWsuFmQ0uWMh1oe8K6w",
"auth0ConnectionIds" : [ "auth0-opaque-connectionId-2", "auth0-opaque-connectionId-1" ]
}
Identity Preference Flow
Find Identity Preferences
GET /identity-preferences
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJmM3dHdEpkRUY5elVmOGxXb2d2WW1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk4LCJleHAiOjE3MTk5MTkwOTgsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 434
[ {
"id" : "93e4bccf-1dcc-4190-a0ac-e9c9d8c594b4",
"userIdentityId" : "674274ed-88e1-43d2-91f4-e2ce416ae774",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "674274ed-88e1-43d2-91f4-e2ce416ae774",
"createdAt" : {
"nano" : 267421000,
"epochSecond" : 1719915498
},
"updatedAt" : {
"nano" : 267421000,
"epochSecond" : 1719915498
},
"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}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/039b2a5f-64f8-46ed-9934-42f875397969' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJmM3dHdEpkRUY5elVmOGxXb2d2WW1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk4LCJleHAiOjE3MTk5MTkwOTgsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "039b2a5f-64f8-46ed-9934-42f875397969",
"userIdentityId" : "0e5ad97a-21d6-4eac-a867-c1e3ce9e58cb",
"preferences" : {
"hello" : "world"
},
"createdBy" : "0e5ad97a-21d6-4eac-a867-c1e3ce9e58cb",
"createdAt" : {
"nano" : 784459000,
"epochSecond" : 1719915498
},
"updatedAt" : {
"nano" : 784459000,
"epochSecond" : 1719915498
},
"deletedBy" : null,
"deletedAt" : null
}
Create Identity Preference
POST /identity-preferences
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJmM3dHdEpkRUY5elVmOGxXb2d2WW1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk4LCJleHAiOjE3MTk5MTkwOTgsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"userIdentityId":"e7b0d38e-8d75-4bc5-9255-9f57a446210e","preferences":{"first":"my first preference."}}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "66e36220-6267-403f-9110-4b97f3d0dfd7",
"userIdentityId" : "e7b0d38e-8d75-4bc5-9255-9f57a446210e",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 520390000,
"epochSecond" : 1719915498
},
"updatedAt" : {
"nano" : 520390000,
"epochSecond" : 1719915498
},
"deletedBy" : null,
"deletedAt" : null
}
Update Identity Preference
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
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
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/a64097ca-0269-4d14-b02f-a70e62bf5e00' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJmM3dHdEpkRUY5elVmOGxXb2d2WW1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk4LCJleHAiOjE3MTk5MTkwOTgsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"preferences":{"updated":"my second preference."}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 433
{
"id" : "a64097ca-0269-4d14-b02f-a70e62bf5e00",
"userIdentityId" : "f0d13728-51da-4d7e-8449-516bc54391c7",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "f0d13728-51da-4d7e-8449-516bc54391c7",
"createdAt" : {
"nano" : 875266000,
"epochSecond" : 1719915498
},
"updatedAt" : {
"nano" : 886732000,
"epochSecond" : 1719915498
},
"deletedBy" : null,
"deletedAt" : null
}
Delete Identity Preference
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}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/550ba76e-654a-48b3-9275-3b62107a228f' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJmM3dHdEpkRUY5elVmOGxXb2d2WW1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NDk4LCJleHAiOjE3MTk5MTkwOTgsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "550ba76e-654a-48b3-9275-3b62107a228f",
"userIdentityId" : "4da14a85-1e4d-4c80-8a2d-0c5ce2a9d519",
"preferences" : {
"hello" : "world"
},
"createdBy" : "4da14a85-1e4d-4c80-8a2d-0c5ce2a9d519",
"createdAt" : {
"nano" : 723773000,
"epochSecond" : 1719915498
},
"updatedAt" : {
"nano" : 734329000,
"epochSecond" : 1719915498
},
"deletedBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"deletedAt" : {
"nano" : 733000000,
"epochSecond" : 1719915498
}
}
Organization Preference Flow
Find Organization Preferences
GET /organization-preferences
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
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 \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJrZ0pMak9ld3JfWHAycTFRdGRnRGRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1266
[ {
"id" : "7d2e1488-48d2-443a-9438-6ff79f7869d3",
"organizationId" : "8a85e3e1-d24a-4056-b746-2ef285dcd15c",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 139282000,
"epochSecond" : 1719915503
},
"updatedAt" : {
"nano" : 139282000,
"epochSecond" : 1719915503
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "8901e19a-091c-46be-b009-419105900ace",
"organizationId" : "7e3d2ead-3c24-4942-95a2-2c312bfc4890",
"preferences" : {
"hello" : "world"
},
"createdBy" : "8c03e2a1-3f56-450d-8319-8eec5a6e5c4c",
"createdAt" : {
"nano" : 218661000,
"epochSecond" : 1719915503
},
"updatedAt" : {
"nano" : 218661000,
"epochSecond" : 1719915503
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "dada4c57-1f28-4143-993a-9a9c2ddfd874",
"organizationId" : "70a4aed3-20d1-4774-ad44-408482b884a2",
"preferences" : {
"hello" : "world"
},
"createdBy" : "68cb4a29-dad3-48c3-8303-84dd4650b995",
"createdAt" : {
"nano" : 66137000,
"epochSecond" : 1719915503
},
"updatedAt" : {
"nano" : 66137000,
"epochSecond" : 1719915503
},
"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}}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/8901e19a-091c-46be-b009-419105900ace' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJrZ0pMak9ld3JfWHAycTFRdGRnRGRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "8901e19a-091c-46be-b009-419105900ace",
"organizationId" : "7e3d2ead-3c24-4942-95a2-2c312bfc4890",
"preferences" : {
"hello" : "world"
},
"createdBy" : "8c03e2a1-3f56-450d-8319-8eec5a6e5c4c",
"createdAt" : {
"nano" : 218661000,
"epochSecond" : 1719915503
},
"updatedAt" : {
"nano" : 218661000,
"epochSecond" : 1719915503
},
"deletedBy" : null,
"deletedAt" : null
}
Create Organization Preference
POST /organization-preferences
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
No parameters.
Query parameters
No parameters.
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' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJrZ0pMak9ld3JfWHAycTFRdGRnRGRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"organizationId":"8a85e3e1-d24a-4056-b746-2ef285dcd15c","preferences":{"first":"my first preference."}}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "7d2e1488-48d2-443a-9438-6ff79f7869d3",
"organizationId" : "8a85e3e1-d24a-4056-b746-2ef285dcd15c",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"createdAt" : {
"nano" : 139282000,
"epochSecond" : 1719915503
},
"updatedAt" : {
"nano" : 139282000,
"epochSecond" : 1719915503
},
"deletedBy" : null,
"deletedAt" : null
}
Update Organization Preference
PUT /organization-preferences/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
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/b7297727-bea8-444a-86e4-33db0b0d2c66' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJrZ0pMak9ld3JfWHAycTFRdGRnRGRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.' \
-d '{"preferences":{"updated":"my second preference."}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 433
{
"id" : "b7297727-bea8-444a-86e4-33db0b0d2c66",
"organizationId" : "92584025-2bc9-40e9-8d46-a778b9f27b51",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "dffc1311-40e7-4d41-b4fd-9d12d8afbf06",
"createdAt" : {
"nano" : 389725000,
"epochSecond" : 1719915503
},
"updatedAt" : {
"nano" : 403401000,
"epochSecond" : 1719915503
},
"deletedBy" : null,
"deletedAt" : null
}
Delete Organization Preference
DELETE /organization-preferences/{id}
Authorization
Valid Authorization Bearer token required, along with a permission grant authorizing access to any referenced resources.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
|
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/9cb8d80f-37ab-4336-9abf-e08af0d7996d' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJqdGkiOiJrZ0pMak9ld3JfWHAycTFRdGRnRGRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjNmJmMzQ5LTVjYWItNGUyNy05YWQyLWViMGNiOWFjM2ZkZSIsImF1ZCI6ImlkZW50aXR5IiwiaWF0IjoxNzE5OTE1NTAzLCJleHAiOjE3MTk5MTkxMDMsInBvbGljaWVzIjpbeyJyZXNvdXJjZXMiOlsibmZybjoqIl0sImFjdGlvbnMiOlsiKjoqIl19XSwiZ3JhbnRzLXN1cGVyIjoiW3tcImlkXCI6XCI1YzgxZDc4MS1jZDFlLTQxZjEtOWNjNy1iNTVmZjcxODhmMzhcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTd9LHtcImlkXCI6XCI5NjI4NGMxOS1mZGU0LTQyNmMtYjYxZC0zZTA3YTM0YjM3YjNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDN9LHtcImlkXCI6XCJlZDEyY2I1Yy1hOGFiLTQ3ODEtYmE2MS1kNzg0MjM5OWNkMGFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI4NTQ0ZmNjOS1jNzI2LTQzYWItYjUyZi00NzFkNmRiOWFmOTNcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0NTd9LHtcImlkXCI6XCJhZDA1MGY5YS0yMDFhLTQ2NDgtYTBmOS1mZDNkZjY1MWRlODFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTZ9LHtcImlkXCI6XCI1NGZjZWQ5Zi04YzkwLTQ3MWQtOWYwYS0wODBiZDdhNDc4YThcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTl9LHtcImlkXCI6XCI2MThiNWJjOC01MmZlLTQwZjAtODU3Zi0yZjNkYzllMjdhODBcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9LHtcImlkXCI6XCI1ODYzYTI4MC02NGM0LTRmYWUtOWY4Yi0yMDZjMmIwMzFkYzFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU0OTh9LHtcImlkXCI6XCI0MzZlOThjOC1mOWYwLTQ0MDYtOGYxMy1hMjBkM2YzYWYzZDFcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDJ9LHtcImlkXCI6XCIzMmIxNDQ5My1lODg1LTQ4ODItODQyYy01Y2RjNjc4Y2NlYmVcIixcImxhc3RNb2RpZmllZFwiOjE3MTk5MTU1MDF9XSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbXSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "9cb8d80f-37ab-4336-9abf-e08af0d7996d",
"organizationId" : "dba141e8-dc5f-4aa2-b6f1-d709896778d7",
"preferences" : {
"hello" : "world"
},
"createdBy" : "d47c6b31-39e6-4d99-a2c1-794a57cbe617",
"createdAt" : {
"nano" : 170705000,
"epochSecond" : 1719915503
},
"updatedAt" : {
"nano" : 183566000,
"epochSecond" : 1719915503
},
"deletedBy" : "0c6bf349-5cab-4e27-9ad2-eb0cb9ac3fde",
"deletedAt" : {
"nano" : 182000000,
"epochSecond" : 1719915503
}
}