Introduction
This is the NetFoundry identity service
Overview
HTTP verbs
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP verbs.
| Verb | Usage |
|---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource, full updates only |
|
Used to delete an existing resource |
The PATCH method is not used (yet).
|
HTTP status codes
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP status codes.
| Status code | Usage |
|---|---|
|
The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action. |
|
The request has been fulfilled and resulted in a new resource being created. |
|
The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services. |
|
The server successfully processed the request, but is not returning any content. |
|
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
|
The request lacks valid authentication credentials for the target resource. |
|
The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource. |
|
The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible. |
Resources
Organization
Find Organizations
GET /organizations
Query parameters
Supports standard paging query parameters.
| Parameter | Type | Optional | Description |
|---|---|---|---|
realmId |
Object |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
mfaProviders |
Object |
true |
Must be one of [None, GoogleAuthenticator]. |
includeDeleted |
Boolean |
true |
Default value: 'false'. |
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
realmId |
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 |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations' -i -X GET
Example response
HTTP/1.1 200 OK
Link: <https://gateway.netFoundry.io/identity/v1/organizations?page=1>; rel="next", <https://gateway.netFoundry.io/identity/v1/organizations?page=1>; rel="last"
Content-Type: application/json
Content-Length: 2910
[ {
"id" : "0dcb9c17-6454-4030-800f-d63c55c16fa8",
"realmId" : "2259cd12-9949-47b6-8f54-daa3eaaeb61b",
"name" : "World Wide Imports",
"label" : "WW-Imports-368",
"identityProviders" : [ {
"id" : "27db86fa-95ee-4320-96ab-1609e05e0621",
"organizationId" : "0dcb9c17-6454-4030-800f-d63c55c16fa8",
"auth0ConnectionId" : "auth0-opaque-connectionId-369",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 929512000,
"epochSecond" : 1795102152
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 928293000,
"epochSecond" : 1795102152
},
"updatedAt" : null,
"deletedBy" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "1c0f8af7-8e94-4b43-a244-8c1d583ed738",
"realmId" : "60ed98cd-8135-49ad-8d01-ad3f87688ec1",
"name" : "World Wide Imports",
"label" : "WW-Imports-280",
"identityProviders" : [ {
"id" : "061f5ab9-8888-48db-be12-eaf9dd2cdc57",
"organizationId" : "1c0f8af7-8e94-4b43-a244-8c1d583ed738",
"auth0ConnectionId" : "auth0-opaque-connectionId-281",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 90376000,
"epochSecond" : 1795102147
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "0018d9be-bd6e-4fb7-adc9-59989431f985",
"organizationId" : "1c0f8af7-8e94-4b43-a244-8c1d583ed738",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 126350000,
"epochSecond" : 1795102147
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 88926000,
"epochSecond" : 1795102147
},
"updatedAt" : null,
"deletedBy" : null,
"deletedAt" : null,
"deleted" : false
}, {
"id" : "1c5df435-c44d-41bf-b5c8-437404ec2d82",
"realmId" : "b8b7e21b-7443-4ac8-b566-599bd099b3fa",
"name" : "World Wide Imports",
"label" : "WW-Imports-371",
"identityProviders" : [ {
"id" : "4c7d5c93-bb9c-406d-bb9a-ccab41e40c8a",
"organizationId" : "1c5df435-c44d-41bf-b5c8-437404ec2d82",
"auth0ConnectionId" : "auth0-opaque-connectionId-372",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 743836000,
"epochSecond" : 1795102154
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 742656000,
"epochSecond" : 1795102154
},
"updatedAt" : null,
"deletedBy" : null,
"deletedAt" : null,
"deleted" : false
} ]
Get Organization By Self
GET /organizations/self
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/self' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2220
{
"id" : "771f425d-d424-43a9-920e-50abde2c91cb",
"realmId" : "2b551792-324e-4200-ab38-3d17f27ac13d",
"name" : "ACME International, Inc.",
"label" : "ACME-2",
"identityProviders" : [ {
"id" : "dc94ea7f-0989-4828-a5db-7a62a379f6c7",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ConnectionId" : "auth0-opaque-connectionId-4",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 622075000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "429bbb83-38a3-43c0-8fa9-71b3848036f3",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ConnectionId" : "auth0-opaque-connectionId-3",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 614491000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "89f5082e-7b48-46a6-aa14-b67f4a736e18",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"name" : "Standard Role - d69a77ef-d1f8-4fd1-b28d-d8562a5531c1",
"roleType" : "Standard",
"roleId" : "d69a77ef-d1f8-4fd1-b28d-d8562a5531c1",
"createdBy" : "c52ba0c3-88d8-4152-8005-da7361390016",
"createdAt" : {
"nano" : 685708000,
"epochSecond" : 1795102092
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "853ad3c8-a7a0-4a37-8489-e8a2ef242f77",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"name" : "Custom Role - 10350fc7-6066-4f60-9358-bbf336af3451",
"roleType" : "Custom",
"roleId" : "10350fc7-6066-4f60-9358-bbf336af3451",
"createdBy" : "d6af6534-a1db-41fd-afd3-118457dfb33e",
"createdAt" : {
"nano" : 696276000,
"epochSecond" : 1795102092
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 611754000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedBy" : null,
"deletedAt" : null,
"deleted" : false
}
Get Organization By Id
GET /organizations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
realmId |
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 |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/771f425d-d424-43a9-920e-50abde2c91cb' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2220
{
"id" : "771f425d-d424-43a9-920e-50abde2c91cb",
"realmId" : "2b551792-324e-4200-ab38-3d17f27ac13d",
"name" : "ACME International, Inc.",
"label" : "ACME-2",
"identityProviders" : [ {
"id" : "dc94ea7f-0989-4828-a5db-7a62a379f6c7",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ConnectionId" : "auth0-opaque-connectionId-4",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 622075000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "429bbb83-38a3-43c0-8fa9-71b3848036f3",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ConnectionId" : "auth0-opaque-connectionId-3",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 614491000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ {
"id" : "89f5082e-7b48-46a6-aa14-b67f4a736e18",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"name" : "Standard Role - d69a77ef-d1f8-4fd1-b28d-d8562a5531c1",
"roleType" : "Standard",
"roleId" : "d69a77ef-d1f8-4fd1-b28d-d8562a5531c1",
"createdBy" : "c52ba0c3-88d8-4152-8005-da7361390016",
"createdAt" : {
"nano" : 685708000,
"epochSecond" : 1795102092
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "853ad3c8-a7a0-4a37-8489-e8a2ef242f77",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"name" : "Custom Role - 10350fc7-6066-4f60-9358-bbf336af3451",
"roleType" : "Custom",
"roleId" : "10350fc7-6066-4f60-9358-bbf336af3451",
"createdBy" : "d6af6534-a1db-41fd-afd3-118457dfb33e",
"createdAt" : {
"nano" : 696276000,
"epochSecond" : 1795102092
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 611754000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedBy" : null,
"deletedAt" : null,
"deleted" : false
}
Get Organization By Label
GET /organizations/label/{label:[a-zA-Z0-9]+[-a-zA-Z0-9]{1,62}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
label |
String |
false |
Query parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
realm |
String |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
realmId |
String |
true |
|
name |
String |
true |
|
label |
String |
true |
|
active |
Boolean |
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 |
|
mfaProvider |
String |
true |
Must be one of [None, GoogleAuthenticator]. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/label/ACME-2' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1060
{
"id" : "771f425d-d424-43a9-920e-50abde2c91cb",
"realmId" : "2b551792-324e-4200-ab38-3d17f27ac13d",
"name" : "ACME International, Inc.",
"label" : "ACME-2",
"active" : true,
"identityProviders" : [ {
"id" : "dc94ea7f-0989-4828-a5db-7a62a379f6c7",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ConnectionId" : "auth0-opaque-connectionId-4",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 622075000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "429bbb83-38a3-43c0-8fa9-71b3848036f3",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ConnectionId" : "auth0-opaque-connectionId-3",
"name" : "ACME Federated Active Directory",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 614491000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedAt" : null
} ],
"mfaProvider" : null
}
Create Organization
POST /organizations
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
realmId |
String |
true |
|
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 |
|
realmId |
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 |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"realmId" : "cb262fe0-46f3-410d-b923-75f784466b4d",
"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: 812
{
"id" : "74103f4e-c006-426b-97a1-9598477281ea",
"realmId" : "cb262fe0-46f3-410d-b923-75f784466b4d",
"name" : "Best Corp.",
"label" : "BEST-CORP",
"identityProviders" : [ {
"id" : "4e9604ce-ed68-4144-a76a-9850e37c85af",
"organizationId" : "74103f4e-c006-426b-97a1-9598477281ea",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Best Corp.",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 910712000,
"epochSecond" : 1795102154
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 909838000,
"epochSecond" : 1795102154
},
"updatedAt" : null,
"deletedBy" : null,
"deletedAt" : null,
"deleted" : false
}
Activate Or Deactivate Organization
PUT /organizations/{id}/{action:activate|deactivate}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
realmId |
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 |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/5f3e45e0-bbab-46cf-819d-6c6ab0eecedb/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 893
{
"id" : "5f3e45e0-bbab-46cf-819d-6c6ab0eecedb",
"realmId" : "60ed98cd-8135-49ad-8d01-ad3f87688ec1",
"name" : "World Wide Imports",
"label" : "WW-Imports-393",
"identityProviders" : [ {
"id" : "f3a3d6c3-4b04-4c87-ba4e-9a8b53c2ec61",
"organizationId" : "5f3e45e0-bbab-46cf-819d-6c6ab0eecedb",
"auth0ConnectionId" : "auth0-opaque-connectionId-394",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 577986000,
"epochSecond" : 1795102155
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : false,
"mfaProvider" : null,
"createdAt" : {
"nano" : 576740000,
"epochSecond" : 1795102155
},
"updatedAt" : {
"nano" : 589409000,
"epochSecond" : 1795102155
},
"deletedBy" : null,
"deletedAt" : null,
"deleted" : false
}
Add Identity Provider
POST /organizations/{id}/identity-providers
Authorization
This endpoint requires:
-
create-identity-provideraction on thisorganizationresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
auth0ConnectionId |
String |
true |
|
identityProviderName |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
realmId |
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 |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organizations/3928313d-3068-4c67-924f-66f0b53f196c/identity-providers' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"auth0ConnectionId" : "auth0-opaque-connection",
"identityProviderName" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1232
{
"id" : "3928313d-3068-4c67-924f-66f0b53f196c",
"realmId" : "60ed98cd-8135-49ad-8d01-ad3f87688ec1",
"name" : "World Wide Imports",
"label" : "WW-Imports-389",
"identityProviders" : [ {
"id" : "ddaab6dd-11c2-479d-885e-8c708a806cd3",
"organizationId" : "3928313d-3068-4c67-924f-66f0b53f196c",
"auth0ConnectionId" : "auth0-opaque-connectionId-390",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 388395000,
"epochSecond" : 1795102155
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "fc4dfd45-70f7-486e-8a56-81ffbdb80f0d",
"organizationId" : "3928313d-3068-4c67-924f-66f0b53f196c",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 405047000,
"epochSecond" : 1795102155
},
"updatedAt" : null,
"deletedAt" : null
} ],
"defaultRoles" : [ ],
"active" : true,
"mfaProvider" : null,
"createdAt" : {
"nano" : 387013000,
"epochSecond" : 1795102155
},
"updatedAt" : null,
"deletedBy" : null,
"deletedAt" : null,
"deleted" : false
}
OIDC Issuers
Find Oidc Issuers
GET /oidc-issuers
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1218
[ {
"id" : "081e87f2-ac8d-47cb-bf7e-f1577b606f88",
"issuer" : "https://1d6d0c3a-3459-46de-b010-23cc6839c8b0.issuer.idp",
"jwksUri" : "https://1d6d0c3a-3459-46de-b010-23cc6839c8b0.issuer.idp/jwks",
"active" : true,
"createdBy" : "fd877803-4f2e-4cd4-b605-455088410445",
"createdAt" : {
"nano" : 60159000,
"epochSecond" : 1795102153
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "6c72dba0-a155-4804-9a70-89da12149793",
"issuer" : "https://accounts.google.com",
"jwksUri" : "https://www.googleapis.com/oauth2/v3/certs",
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 129879000,
"epochSecond" : 1795102089
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "76aa6e09-ff07-4b84-aa49-2d53b5464211",
"issuer" : "https://51985e70-c8a3-4980-95e8-fd770a1b70f2.issuer.idp",
"jwksUri" : "https://51985e70-c8a3-4980-95e8-fd770a1b70f2.issuer.idp/jwks",
"active" : true,
"createdBy" : "05a3b187-6bcd-43eb-b861-34b88cb2abe5",
"createdAt" : {
"nano" : 739408000,
"epochSecond" : 1795102153
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Oidc Issuer
GET /oidc-issuers/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers/32778e11-e0c5-445c-bc87-f7e765706020' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 419
{
"id" : "32778e11-e0c5-445c-bc87-f7e765706020",
"issuer" : "https://a94e0cd5-7068-469b-aaf2-f2344690dc55.issuer.idp",
"jwksUri" : "https://a94e0cd5-7068-469b-aaf2-f2344690dc55.issuer.idp/jwks",
"active" : true,
"createdBy" : "e0c03440-f548-4e35-bfb8-674ff93af57a",
"createdAt" : {
"nano" : 165748000,
"epochSecond" : 1795102154
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Issuer
POST /oidc-issuers
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"issuer" : "https://a36c81bf-014f-485c-b491-f979997f5ba9.issuer.idp",
"jwksUri" : "https://a36c81bf-014f-485c-b491-f979997f5ba9.issuer.idp/jwks",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 419
{
"id" : "a29c3a04-295d-4f1b-b2bc-c2b31655f600",
"issuer" : "https://a36c81bf-014f-485c-b491-f979997f5ba9.issuer.idp",
"jwksUri" : "https://a36c81bf-014f-485c-b491-f979997f5ba9.issuer.idp/jwks",
"active" : true,
"createdBy" : "3bb31d46-3ab4-4e88-b8fd-ea6f52b93047",
"createdAt" : {
"nano" : 131782000,
"epochSecond" : 1795102154
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Issuer
PATCH /oidc-issuers/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers/28d916c8-18c4-4720-bd9a-8871a112a8d3' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"issuer" : "https://7dc1c7cf-0bc6-4f8c-8a95-f83c91cf92d8.issuer.idp",
"jwksUri" : "https://7dc1c7cf-0bc6-4f8c-8a95-f83c91cf92d8.issuer.idp/jwks",
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 419
{
"id" : "28d916c8-18c4-4720-bd9a-8871a112a8d3",
"issuer" : "https://7dc1c7cf-0bc6-4f8c-8a95-f83c91cf92d8.issuer.idp",
"jwksUri" : "https://7dc1c7cf-0bc6-4f8c-8a95-f83c91cf92d8.issuer.idp/jwks",
"active" : false,
"createdBy" : "5d0f16f8-bad1-4bbe-b09a-7c021f618820",
"createdAt" : {
"nano" : 81033000,
"epochSecond" : 1795102154
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Issuer
DELETE /oidc-issuers/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
issuer |
String |
true |
|
jwksUri |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-issuers/0f538e67-1117-48e0-b409-4672f5d84bad' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 508
{
"id" : "0f538e67-1117-48e0-b409-4672f5d84bad",
"issuer" : "https://9a5a259a-3eec-45e0-822b-0349304dd4c0.issuer.idp",
"jwksUri" : "https://9a5a259a-3eec-45e0-822b-0349304dd4c0.issuer.idp/jwks",
"active" : true,
"createdBy" : "20ad164d-1a3a-420f-8828-92dfd8f64065",
"createdAt" : {
"nano" : 202345000,
"epochSecond" : 1795102154
},
"deletedAt" : {
"nano" : 210327000,
"epochSecond" : 1795102154
},
"deletedBy" : "d2f3e1dc-c968-4054-ae68-2b8a2b7db87d",
"deleted" : true
}
OIDC Public Clients
Find Oidc Public Clients
GET /oidc-public-clients
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2070
[ {
"id" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"oidcIssuerId" : "fc221f2c-e97f-4994-a29e-afc26395f6b6",
"clientId" : "{clientId}",
"clientSecret" : "{clientSecret}",
"authorizationEndpoint" : "https://{auth0-tenant}.auth0.com/authorize",
"tokenEndpoint" : "https://{auth0-tenant}.auth0.com/oauth/token",
"userInfoEndpoint" : "https://{auth0-tenant}.auth0.com/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 133380000,
"epochSecond" : 1795102089
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "6fbb09e2-8184-4e7e-bfd6-4f86081f6d25",
"oidcIssuerId" : "e9025fc7-1690-461f-9987-0cbf042f870e",
"clientId" : "clientId-3b7ac11c-eb3b-4008-a9c9-b13da3a0eacf",
"clientSecret" : "clientSecret-e21ad025-5013-4b54-b6c8-d8f7ae322659",
"authorizationEndpoint" : "https://40301bfe-8ed4-460e-9758-5d2270c09736.issuer.idp/authorize",
"tokenEndpoint" : "https://40301bfe-8ed4-460e-9758-5d2270c09736.issuer.idp/token",
"userInfoEndpoint" : "https://40301bfe-8ed4-460e-9758-5d2270c09736.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "78c9487b-adac-49d2-830f-8883c2504101",
"createdAt" : {
"nano" : 286166000,
"epochSecond" : 1795102154
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "f4e6fcd0-1839-4566-8828-856e42b8f156",
"oidcIssuerId" : "6c72dba0-a155-4804-9a70-89da12149793",
"clientId" : "{clientId}",
"clientSecret" : "{clientSecret}",
"authorizationEndpoint" : "https://accounts.google.com/o/oauth2/v2/auth",
"tokenEndpoint" : "https://oauth2.googleapis.com/token",
"userInfoEndpoint" : "https://openidconnect.googleapis.com/v1/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 133380000,
"epochSecond" : 1795102089
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Oidc Public Client
GET /oidc-public-clients/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients/b7e0a291-463a-48a7-931e-c6fc66117842' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776
{
"id" : "b7e0a291-463a-48a7-931e-c6fc66117842",
"oidcIssuerId" : "214ae5f2-35d7-4bc4-a7e0-738958b51d1f",
"clientId" : "clientId-122dd8a3-43f1-4565-bc8f-a0894c4013f4",
"clientSecret" : "clientSecret-12e9e202-5da5-4181-8d3c-1443cf56576a",
"authorizationEndpoint" : "https://d6e856b4-7d88-4207-8f09-70ec09519cd8.issuer.idp/authorize",
"tokenEndpoint" : "https://d6e856b4-7d88-4207-8f09-70ec09519cd8.issuer.idp/token",
"userInfoEndpoint" : "https://d6e856b4-7d88-4207-8f09-70ec09519cd8.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "c3152944-bb8e-4cd2-b6ae-fa622d94370d",
"createdAt" : {
"nano" : 623282000,
"epochSecond" : 1795102154
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Public Client
POST /oidc-public-clients
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"oidcIssuerId" : "b9dbaf98-c449-4ba5-85a5-13bf06a1c96c",
"clientId" : "clientId-accfd1bb-dc94-48a6-b0c6-0f0891e82128",
"clientSecret" : "clientSecret-026bb9e3-f239-4bf9-b12a-142df6630edf",
"authorizationEndpoint" : "https://7487c876-143e-48eb-8092-d3126a9c1034.issuer.idp/authorize",
"tokenEndpoint" : "https://7487c876-143e-48eb-8092-d3126a9c1034.issuer.idp/token",
"userInfoEndpoint" : "https://7487c876-143e-48eb-8092-d3126a9c1034.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 776
{
"id" : "fe4fd1b7-a69d-41a1-bb41-c7ce6e9dc16e",
"oidcIssuerId" : "b9dbaf98-c449-4ba5-85a5-13bf06a1c96c",
"clientId" : "clientId-accfd1bb-dc94-48a6-b0c6-0f0891e82128",
"clientSecret" : "clientSecret-026bb9e3-f239-4bf9-b12a-142df6630edf",
"authorizationEndpoint" : "https://7487c876-143e-48eb-8092-d3126a9c1034.issuer.idp/authorize",
"tokenEndpoint" : "https://7487c876-143e-48eb-8092-d3126a9c1034.issuer.idp/token",
"userInfoEndpoint" : "https://7487c876-143e-48eb-8092-d3126a9c1034.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "1fbd5393-ec7a-4ba5-98d1-a67b041d8f0b",
"createdAt" : {
"nano" : 584387000,
"epochSecond" : 1795102154
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Public Client
PATCH /oidc-public-clients/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients/c25c8377-c797-4b68-b81a-b6c977a6a675' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"clientId" : "clientId-8d5acf83-8e23-46a5-9fb2-9d7b6209319d",
"clientSecret" : "clientSecret-c60ca3c8-4439-4759-8ec7-bb87a215fe37",
"authorizationEndpoint" : "https://63bd527c-4deb-4b2b-a443-64888573cb7b.issuer.idp/authorize",
"tokenEndpoint" : "https://63bd527c-4deb-4b2b-a443-64888573cb7b.issuer.idp/token",
"userInfoEndpoint" : "https://63bd527c-4deb-4b2b-a443-64888573cb7b.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 777
{
"id" : "c25c8377-c797-4b68-b81a-b6c977a6a675",
"oidcIssuerId" : "755fa4c5-6bad-47b5-8ea6-aa9e027265a0",
"clientId" : "clientId-8d5acf83-8e23-46a5-9fb2-9d7b6209319d",
"clientSecret" : "clientSecret-c60ca3c8-4439-4759-8ec7-bb87a215fe37",
"authorizationEndpoint" : "https://63bd527c-4deb-4b2b-a443-64888573cb7b.issuer.idp/authorize",
"tokenEndpoint" : "https://63bd527c-4deb-4b2b-a443-64888573cb7b.issuer.idp/token",
"userInfoEndpoint" : "https://63bd527c-4deb-4b2b-a443-64888573cb7b.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "1f74a813-0afc-4218-accd-08dc5b57a824",
"createdAt" : {
"nano" : 517463000,
"epochSecond" : 1795102154
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Public Client
DELETE /oidc-public-clients/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
clientId |
String |
true |
|
clientSecret |
String |
true |
|
authorizationEndpoint |
String |
true |
|
tokenEndpoint |
String |
true |
|
userInfoEndpoint |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-public-clients/f7b8f579-6d53-4c00-b17e-55789dc5b2b0' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 865
{
"id" : "f7b8f579-6d53-4c00-b17e-55789dc5b2b0",
"oidcIssuerId" : "537d882a-ea00-4430-bbd1-c005af415082",
"clientId" : "clientId-3f0ff751-dcc0-4334-9e17-829dcd425ad1",
"clientSecret" : "clientSecret-0686a441-c176-48b5-bd89-ea0820d7b702",
"authorizationEndpoint" : "https://7a1a3147-d8d4-4599-b3ff-b31c449124cd.issuer.idp/authorize",
"tokenEndpoint" : "https://7a1a3147-d8d4-4599-b3ff-b31c449124cd.issuer.idp/token",
"userInfoEndpoint" : "https://7a1a3147-d8d4-4599-b3ff-b31c449124cd.issuer.idp/userinfo",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "d930fa94-ef16-4c20-9164-e6564bde6730",
"createdAt" : {
"nano" : 670454000,
"epochSecond" : 1795102154
},
"deletedAt" : {
"nano" : 680071000,
"epochSecond" : 1795102154
},
"deletedBy" : "537a7302-a104-4cd1-83c4-718d499f62a9",
"deleted" : true
}
Organization to OIDC Public Client Mappings
Find Organization Oidc Public Client Mappings
GET /organization-oidc-public-client-mappings
Authorization
This endpoint requires:
-
readaction on thisorganization-oidc-public-client-mappingresource.
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1499
[ {
"id" : "0e08cd50-3dcf-419c-a623-52306f3f7bad",
"organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "NetFoundry Google Account",
"active" : true,
"customQueryParameters" : "{\"audience\": \"https://gateway.{env}.netfoundry.io/\", \"connection\": \"google-oauth2\"}",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 780990000,
"epochSecond" : 1795102088
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "3bdcc247-fb56-4db6-9c42-6671a6e6e686",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"oidcPublicClientId" : "f4e6fcd0-1839-4566-8828-856e42b8f156",
"name" : "Google-Account",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "36515415-7520-49ce-aa4a-4148d7e68add",
"createdAt" : {
"nano" : 679869000,
"epochSecond" : 1795102092
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "44c9fd63-84d8-46fa-9845-eb0496709205",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
"name" : "ACME Federated Active Directory",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "6f06a19f-2452-4b8b-924f-56896aaa72ed",
"createdAt" : {
"nano" : 664244000,
"epochSecond" : 1795102092
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Organization Oidc Public Client Mapping
GET /organization-oidc-public-client-mappings/{id}
Authorization
This endpoint requires:
-
readaction on thisorganization-oidc-public-client-mappingresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/2d6ac48c-e249-4928-ab0d-b8fb095da490' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 495
{
"id" : "2d6ac48c-e249-4928-ab0d-b8fb095da490",
"organizationId" : "57d3e3f3-3f01-4004-aecc-deaff9008301",
"oidcPublicClientId" : "d3b2dd58-6a9f-414b-b7fc-642c3c14abf4",
"name" : "console-client-0178bd48-f852-4f38-b17c-30b073519b12",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "b929fa18-7e98-4fa8-864e-9f2188baa0af",
"createdAt" : {
"nano" : 354764000,
"epochSecond" : 1795102156
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Organization Oidc Public Client Mapping
POST /organization-oidc-public-client-mappings
Authorization
This endpoint requires:
-
createaction on thisorganization-oidc-public-client-mappingresource. -
readaction on theoidc-public-clientresource identified by theoidcPublicClientIdproperty.
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "777abd9a-dbd5-401a-adb2-52b88d36fb1a",
"oidcPublicClientId" : "d5440c35-c54f-4d23-a801-aa4a8f290da7",
"name" : "console-client-e0e666a9-a9cc-427b-a9b8-06654c90e807",
"active" : true,
"customQueryParameters" : "{}"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 495
{
"id" : "d9972da2-09cc-4dab-a7ac-da866838b6ba",
"organizationId" : "777abd9a-dbd5-401a-adb2-52b88d36fb1a",
"oidcPublicClientId" : "d5440c35-c54f-4d23-a801-aa4a8f290da7",
"name" : "console-client-e0e666a9-a9cc-427b-a9b8-06654c90e807",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "2989003f-9ada-4e55-8be4-923085833eff",
"createdAt" : {
"nano" : 295001000,
"epochSecond" : 1795102156
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Organization Oidc Public Client Mapping
PATCH /organization-oidc-public-client-mappings/{id}
Authorization
This endpoint requires:
-
updateaction on thisorganization-oidc-public-client-mappingresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/ca3a8c73-c5e9-4e6d-a545-98e98f9537cd' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"name" : "custom-client-45ebdb12-3192-4775-becb-999a41cea8d8",
"active" : true,
"customQueryParameters" : "{}"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 494
{
"id" : "ca3a8c73-c5e9-4e6d-a545-98e98f9537cd",
"organizationId" : "1eadd72d-3540-4c00-92d2-b07f866383e4",
"oidcPublicClientId" : "ee14f107-895b-4d06-b457-82e4fe21a381",
"name" : "custom-client-45ebdb12-3192-4775-becb-999a41cea8d8",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "508dbb07-7e72-47ee-b4b2-1ca90bd0dc5d",
"createdAt" : {
"nano" : 119161000,
"epochSecond" : 1795102156
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Organization Oidc Public Client Mapping
DELETE /organization-oidc-public-client-mappings/{id}
Authorization
This endpoint requires:
-
deleteaction on thisorganization-oidc-public-client-mappingresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
oidcPublicClientId |
String |
true |
|
name |
String |
true |
|
active |
Boolean |
true |
|
customQueryParameters |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/d2b91fe4-58a6-458e-9687-e5087bfc85dd' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 543
{
"id" : "d2b91fe4-58a6-458e-9687-e5087bfc85dd",
"organizationId" : "6f184196-5dcb-418c-9b76-0ea469d89f8c",
"oidcPublicClientId" : "9c4694cf-3b95-486c-bd0c-d54e24f5812f",
"name" : "number two",
"active" : true,
"customQueryParameters" : "{}",
"createdBy" : "f819bdd9-0e0a-4f87-8490-8e018ca5e6b9",
"createdAt" : {
"nano" : 453336000,
"epochSecond" : 1795102156
},
"deletedAt" : {
"nano" : 477107000,
"epochSecond" : 1795102156
},
"deletedBy" : "d58acc15-4dfd-4a68-9e5e-685c1b5975ce",
"deleted" : true
}
OIDC Audiences
Find Oidc Audiences
GET /oidc-audiences
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1281
[ {
"id" : "3b8f42fc-6ef0-40d2-bc8a-7a3483de185f",
"oidcIssuerId" : "081e87f2-ac8d-47cb-bf7e-f1577b606f88",
"audience" : "mop-aud-a73bb381-0c4f-472d-8511-e2c8e13ea6e3",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "3aab9499-c717-43c9-bb07-eee22f26113d",
"createdAt" : {
"nano" : 80253000,
"epochSecond" : 1795102153
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "6a4f65ad-9db8-4ea7-b404-1d5c5f85cbdf",
"oidcIssuerId" : "fc221f2c-e97f-4994-a29e-afc26395f6b6",
"audience" : "https://gateway.{env}.netfoundry.io/",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 139133000,
"epochSecond" : 1795102089
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "b71d8edd-6bf1-4ed3-84e8-f3b5fe82868f",
"oidcIssuerId" : "6c72dba0-a155-4804-9a70-89da12149793",
"audience" : "https://gateway.{env}.netfoundry.io/",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 139133000,
"epochSecond" : 1795102089
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Oidc Audience
GET /oidc-audiences/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences/4fe62b4e-816f-4cdd-969e-6c68e027d3ae' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430
{
"id" : "4fe62b4e-816f-4cdd-969e-6c68e027d3ae",
"oidcIssuerId" : "a933f2a9-1ee4-4207-b8c0-4463d85d950b",
"audience" : "mop-aud-74887ea4-a1f4-478e-ad14-6bfb5aa0e11f",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "721b4330-4712-45fe-b51b-9333767f6f0a",
"createdAt" : {
"nano" : 700905000,
"epochSecond" : 1795102153
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Oidc Audience
POST /oidc-audiences
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"oidcIssuerId" : "ba9a61bb-19cb-4d10-8177-9b43ca7c47ca",
"audience" : "mop-aud-f724dc4c-e2f3-4fbf-b403-27710045623c",
"restrictedToOrganizationIds" : [ ],
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "f7411b25-c4a6-49ff-8767-6b017e610a74",
"oidcIssuerId" : "ba9a61bb-19cb-4d10-8177-9b43ca7c47ca",
"audience" : "mop-aud-f724dc4c-e2f3-4fbf-b403-27710045623c",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "1862a4e3-85ec-4045-b91b-a5365fabb213",
"createdAt" : {
"nano" : 662901000,
"epochSecond" : 1795102153
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update Oidc Audience
PATCH /oidc-audiences/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences/e79bd82c-7fc1-49af-9eed-10eca2bc92c1' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"audience" : "mop-aud-44f8d74e-d787-45ec-9f9d-73d0284268da",
"restrictedToOrganizationIds" : [ ],
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "e79bd82c-7fc1-49af-9eed-10eca2bc92c1",
"oidcIssuerId" : "e0b22e83-e178-4ccf-9be4-86b665a84333",
"audience" : "mop-aud-44f8d74e-d787-45ec-9f9d-73d0284268da",
"restrictedToOrganizationIds" : [ ],
"active" : false,
"createdBy" : "7bc4ff95-bb8a-4a8c-bdc7-993ed6ba8bbb",
"createdAt" : {
"nano" : 505187000,
"epochSecond" : 1795102153
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Oidc Audience
DELETE /oidc-audiences/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
oidcIssuerId |
String |
true |
|
audience |
String |
true |
|
restrictedToOrganizationIds |
Array[Object] |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/oidc-audiences/11e68a85-5ec4-477b-9871-495eacb1f8b8' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 519
{
"id" : "11e68a85-5ec4-477b-9871-495eacb1f8b8",
"oidcIssuerId" : "76aa6e09-ff07-4b84-aa49-2d53b5464211",
"audience" : "mop-aud-66793c6d-c8bf-40d5-8b76-2dd60c049f68",
"restrictedToOrganizationIds" : [ ],
"active" : true,
"createdBy" : "e8769cbb-70f9-42f5-81b6-d7947edfa9be",
"createdAt" : {
"nano" : 742742000,
"epochSecond" : 1795102153
},
"deletedAt" : {
"nano" : 752602000,
"epochSecond" : 1795102153
},
"deletedBy" : "15d0f12e-a783-45ae-baa2-1d6dc5bccc8b",
"deleted" : true
}
User Identity to OIDC Audience Mappings
Find User Identity Audience Mappings
GET /user-identity-oidc-audience-mappings
Authorization
This endpoint requires:
-
readaction on thisuser-identity-oidc-audience-mappingresource.
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3
[ ]
Get User Identity Audience Mapping
GET /user-identity-oidc-audience-mappings/{id}
Authorization
This endpoint requires:
-
readaction on thisuser-identity-oidc-audience-mappingresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/52fa5b24-afc1-4dc7-b2f2-386bb106f320' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 460
{
"id" : "52fa5b24-afc1-4dc7-b2f2-386bb106f320",
"userIdentityId" : "1b3e830c-5664-430a-9d39-41837ffc5333",
"oidcAudienceId" : "8d552be0-c1db-4769-9386-d40fb3222993",
"subject" : "console-client-8d8e2ee0-a720-4d25-8f2e-74d4ecde804f",
"active" : true,
"createdBy" : "6f82ea1b-ab9d-487a-a7f1-b3b0ed1319ad",
"createdAt" : {
"nano" : 417720000,
"epochSecond" : 1795102160
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create User Identity Audience Mapping
POST /user-identity-oidc-audience-mappings
Authorization
This endpoint requires:
-
createaction on thisuser-identity-oidc-audience-mappingresource. -
create-identity-mappingaction on theuser-identityresource identified by theuserIdentityIdproperty. -
readaction on theoidc-audienceresource identified by theoidcAudienceIdproperty.
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"userIdentityId" : "6d996893-9523-4730-91b1-d8f6466770b1",
"oidcAudienceId" : "96243a3f-b470-4515-ac45-79d3ae23ba67",
"subject" : "console-client-1c0f41c3-0fd2-4146-8c0f-95c29b3fa2bb",
"active" : true
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 460
{
"id" : "55b076fb-304c-4b4d-bcaf-3db083c3e223",
"userIdentityId" : "6d996893-9523-4730-91b1-d8f6466770b1",
"oidcAudienceId" : "96243a3f-b470-4515-ac45-79d3ae23ba67",
"subject" : "console-client-1c0f41c3-0fd2-4146-8c0f-95c29b3fa2bb",
"active" : true,
"createdBy" : "9b3410af-16a4-4556-a71a-4effc2a1c236",
"createdAt" : {
"nano" : 373259000,
"epochSecond" : 1795102160
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Update User Identity Audience Mapping
PATCH /user-identity-oidc-audience-mappings/{id}
Authorization
This endpoint requires:
-
updateaction on thisuser-identity-oidc-audience-mappingresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
active |
Boolean |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/402fcca8-59cc-46b4-8be8-f4fa97f037ca' -i -X PATCH \
-H 'Content-Type: application/json' \
-d '{
"active" : false
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 461
{
"id" : "402fcca8-59cc-46b4-8be8-f4fa97f037ca",
"userIdentityId" : "7fd88862-1746-4ac4-b160-f03645e558b1",
"oidcAudienceId" : "1bda557b-0179-4cbe-8093-21b3f5229e0d",
"subject" : "console-client-399e60c2-4a97-4959-8214-742536c76747",
"active" : false,
"createdBy" : "17910d1e-4097-4a8d-ab55-edca1886d6ee",
"createdAt" : {
"nano" : 298104000,
"epochSecond" : 1795102160
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete User Identity Audience Mapping
DELETE /user-identity-oidc-audience-mappings/{id}
Authorization
This endpoint requires:
-
deleteaction on thisuser-identity-oidc-audience-mappingresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
oidcAudienceId |
String |
true |
|
subject |
String |
true |
|
active |
Boolean |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/85a25c6f-533f-441a-99bf-e88cf56a87a7' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 549
{
"id" : "85a25c6f-533f-441a-99bf-e88cf56a87a7",
"userIdentityId" : "71e32fd5-aa4f-482d-b3e6-5402d61fd0eb",
"oidcAudienceId" : "18b4fd77-7639-4c56-b79d-a3d680c5a0e9",
"subject" : "console-client-0bb0c786-b9b3-4b25-a6f8-439d7f4d6df6",
"active" : true,
"createdBy" : "e4896a97-7aa9-4329-a817-e61bb557b2ef",
"createdAt" : {
"nano" : 567185000,
"epochSecond" : 1795102160
},
"deletedAt" : {
"nano" : 607114000,
"epochSecond" : 1795102160
},
"deletedBy" : "3cfbe317-add4-41d5-87c9-bc04890b5c55",
"deleted" : true
}
Identity Providers
Find Identity Providers
GET /identity-providers
Query parameters
Supports standard paging query parameters.
| Parameter | Type | Optional | Description |
|---|---|---|---|
name |
String |
true |
|
organizationId |
Object |
true |
|
auth0ConnectionId |
Object |
true |
|
auth0ConnectionType |
Object |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
deleted |
Object |
true |
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1125
[ {
"id" : "0018d9be-bd6e-4fb7-adc9-59989431f985",
"organizationId" : "1c0f8af7-8e94-4b43-a244-8c1d583ed738",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 126350000,
"epochSecond" : 1795102147
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "061f5ab9-8888-48db-be12-eaf9dd2cdc57",
"organizationId" : "1c0f8af7-8e94-4b43-a244-8c1d583ed738",
"auth0ConnectionId" : "auth0-opaque-connectionId-281",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 90376000,
"epochSecond" : 1795102147
},
"updatedAt" : null,
"deletedAt" : null
}, {
"id" : "0e08cd50-3dcf-419c-a623-52306f3f7bad",
"organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
"auth0ConnectionId" : "google-oauth2",
"name" : "NetFoundry Google Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 780990000,
"epochSecond" : 1795102088
},
"updatedAt" : null,
"deletedAt" : null
} ]
Get Identity Provider
GET /identity-providers/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
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/dc94ea7f-0989-4828-a5db-7a62a379f6c7' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 373
{
"id" : "dc94ea7f-0989-4828-a5db-7a62a379f6c7",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ConnectionId" : "auth0-opaque-connectionId-4",
"name" : "Google-Account",
"auth0ConnectionType" : "Social",
"active" : true,
"createdAt" : {
"nano" : 622075000,
"epochSecond" : 1795102092
},
"updatedAt" : null,
"deletedAt" : null
}
Create Identity Provider
POST /identity-providers
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "1c0f8af7-8e94-4b43-a244-8c1d583ed738",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 368
{
"id" : "0018d9be-bd6e-4fb7-adc9-59989431f985",
"organizationId" : "1c0f8af7-8e94-4b43-a244-8c1d583ed738",
"auth0ConnectionId" : "auth0-opaque-connection",
"name" : "Corp SAML",
"auth0ConnectionType" : "Enterprise",
"active" : true,
"createdAt" : {
"nano" : 126350000,
"epochSecond" : 1795102147
},
"updatedAt" : null,
"deletedAt" : null
}
Update Identity Provider
PUT /identity-providers/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
name |
String |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers/ec0d823c-6a4f-441d-9eb9-fca47b8d2be3' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"name" : "New IdP Name"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431
{
"id" : "ec0d823c-6a4f-441d-9eb9-fca47b8d2be3",
"organizationId" : "c8050707-de0d-47a3-96a4-ebed2e0f92aa",
"auth0ConnectionId" : "auth0-opaque-connectionId-289",
"name" : "New IdP Name",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 385395000,
"epochSecond" : 1795102147
},
"updatedAt" : {
"nano" : 404560000,
"epochSecond" : 1795102147
},
"deletedAt" : null
}
Activate Or Deactivate Identity Provider
PUT /identity-providers/{id}/{action:activate|deactivate}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers/16679d4b-8754-4c10-be60-fa8c44b0fb84/activate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "16679d4b-8754-4c10-be60-fa8c44b0fb84",
"organizationId" : "c2b1d1e3-364f-42dc-bfc0-cc556e08bb87",
"auth0ConnectionId" : "auth0-opaque-connectionId-283",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 216393000,
"epochSecond" : 1795102147
},
"updatedAt" : null,
"deletedAt" : null
}
Delete Identity Provider
DELETE /identity-providers/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ConnectionId |
String |
true |
|
name |
String |
true |
|
auth0ConnectionType |
String |
true |
Must be one of [Database, Social, Enterprise, Passwordless]. |
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-providers/58c7aad4-9dcb-46f3-b96b-c1c80b9e3e14' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "58c7aad4-9dcb-46f3-b96b-c1c80b9e3e14",
"organizationId" : "327ee750-2be5-4d6a-888d-9ad3d2b632af",
"auth0ConnectionId" : "auth0-opaque-connectionId-287",
"name" : "Username/Password",
"auth0ConnectionType" : "Database",
"active" : true,
"createdAt" : {
"nano" : 333706000,
"epochSecond" : 1795102147
},
"updatedAt" : {
"nano" : 346160000,
"epochSecond" : 1795102147
},
"deletedAt" : {
"nano" : 345000000,
"epochSecond" : 1795102147
}
}
Default Roles
Find Default Roles
GET /default-roles
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
name |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1355
[ {
"id" : "0759369f-64cf-4cbc-87ac-8b33a84e655b",
"organizationId" : "cc2433a9-c951-4a30-a57f-c23567fe7b87",
"name" : "Network Group Admin - NF Support (NFSUP) Network Group",
"roleType" : "Standard",
"roleId" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 626551000,
"epochSecond" : 1795102141
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "1aa47ba1-7494-4e03-bb13-f5d3b5fc88a4",
"organizationId" : "f86122fb-316b-4427-8c38-248165bf4504",
"name" : "NF Support - Intervention",
"roleType" : "Custom",
"roleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
"createdAt" : {
"nano" : 613770000,
"epochSecond" : 1795102141
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}, {
"id" : "20427d55-1bea-40d3-bbd6-c9ae05eb6552",
"organizationId" : "bc588a1e-a2c5-4bd7-919e-4d0704ae9fd2",
"name" : "Standard Role - d68fac11-3de2-4154-9e6d-fdc0076ddff2",
"roleType" : "Standard",
"roleId" : "d68fac11-3de2-4154-9e6d-fdc0076ddff2",
"createdBy" : "897c1ac8-628b-487f-811d-0ab0be49f5ed",
"createdAt" : {
"nano" : 687700000,
"epochSecond" : 1795102142
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
} ]
Get Default Role
GET /default-roles/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
name |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles/4a637e3c-0817-4375-8bf4-f898643bf889' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 454
{
"id" : "4a637e3c-0817-4375-8bf4-f898643bf889",
"organizationId" : "911bb8c3-4cd8-4056-b881-d5805fe2cf87",
"name" : "Custom Role - 90c5757c-6b7b-420d-83c8-90c78574c056",
"roleType" : "Custom",
"roleId" : "90c5757c-6b7b-420d-83c8-90c78574c056",
"createdBy" : "76e5896e-8da7-4ef6-b945-bbc5991ef896",
"createdAt" : {
"nano" : 636773000,
"epochSecond" : 1795102142
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Create Default Role
POST /default-roles
Authorization
This endpoint requires:
-
createaction on thisdefault-roleresource. -
updateaction on theorganizationresource identified by theorganizationproperty.
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
organizationId |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
name |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "6d4329d3-b73e-49ff-b8b4-801b7402568a",
"roleType" : "Standard",
"roleId" : "048f2dfe-721b-4135-ae0c-180a5bd1f846"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 458
{
"id" : "64e6e559-cbd9-4dc0-a074-ee0e651bdd7a",
"organizationId" : "6d4329d3-b73e-49ff-b8b4-801b7402568a",
"name" : "Standard Role - 048f2dfe-721b-4135-ae0c-180a5bd1f846",
"roleType" : "Standard",
"roleId" : "048f2dfe-721b-4135-ae0c-180a5bd1f846",
"createdBy" : "7083b852-575f-49d6-958f-73dc630fce1e",
"createdAt" : {
"nano" : 423051000,
"epochSecond" : 1795102143
},
"deletedAt" : null,
"deletedBy" : null,
"deleted" : false
}
Delete Default Role
DELETE /default-roles/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
name |
String |
true |
|
roleType |
String |
true |
Must be one of [Standard, Custom]. |
roleId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deleted |
Boolean |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles/1b9fa616-b87f-40f7-8c32-a87b1d205a02' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 547
{
"id" : "1b9fa616-b87f-40f7-8c32-a87b1d205a02",
"organizationId" : "911bb8c3-4cd8-4056-b881-d5805fe2cf87",
"name" : "Standard Role - 00c79ace-38f6-4c6d-99c9-364cde397a7c",
"roleType" : "Standard",
"roleId" : "00c79ace-38f6-4c6d-99c9-364cde397a7c",
"createdBy" : "c334caf2-cb16-4a43-8c7b-a02b986eca3c",
"createdAt" : {
"nano" : 233295000,
"epochSecond" : 1795102143
},
"deletedAt" : {
"nano" : 243000000,
"epochSecond" : 1795102143
},
"deletedBy" : "5acf1723-07c2-4ec9-a60c-224b5e8acfc5",
"deleted" : true
}
Grant Default Role
POST /default-roles/{id}/grant
Authorization
This endpoint requires:
-
readaction on thisdefault-roleresource. -
createaction on theinvitationresource identified by theorganizationproperty.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles/20427d55-1bea-40d3-bbd6-c9ae05eb6552/grant' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"includeIdentityIds" : [ "ffe88c18-53ce-4576-baec-59b9d5442784", "6c152b1f-8227-4284-846c-8bd833feb298", "0eb3609d-47de-4775-b67a-a091cea8e5b4" ],
"excludeIdentityIds" : [ "92c80567-296a-4344-a24f-b50ef05543c9", "ffe88c18-53ce-4576-baec-59b9d5442784", "6c152b1f-8227-4284-846c-8bd833feb298" ]
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51
{
"0eb3609d-47de-4775-b67a-a091cea8e5b4" : true
}
User Identity
Get Identity
GET /identities/self
Authorization
This endpoint requires no specific permission, only an authenticated client.
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
name |
String |
true |
|
id |
String |
true |
|
type |
String |
true |
|
active |
Boolean |
true |
|
organizationId |
String |
true |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
createdAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identities/self' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 778
{
"id" : "50cdcaad-e352-4842-9129-64506a9f0345",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-467@acme.com",
"identityMappings" : [ {
"id" : "edbbaba2-d4b2-4359-b3c8-72a22cf4c4d4",
"auth0UserId" : "auth0-opaque-userId-468",
"identityProviderId" : "da6e31cd-9ae3-4227-916b-d7c882bea2ae",
"userIdentityId" : "50cdcaad-e352-4842-9129-64506a9f0345"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 685529000,
"epochSecond" : 1795102158
},
"deletedAt" : null,
"invited" : false,
"tags" : { },
"name" : "First Last",
"status" : "ACTIVE",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}
Get Identity
GET /identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
name |
String |
true |
|
id |
String |
true |
|
type |
String |
true |
|
active |
Boolean |
true |
|
organizationId |
String |
true |
|
deletedAt |
Object |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
createdAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identities/550d268a-7008-4578-bb2b-bd3f18f39e0e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 772
{
"id" : "550d268a-7008-4578-bb2b-bd3f18f39e0e",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "117308ab-323b-4aac-99a0-e727c5eda752",
"auth0UserId" : "auth0-opaque-userId-336",
"identityProviderId" : "88aab295-b2bd-4ea1-acfb-80fd209202d3",
"userIdentityId" : "550d268a-7008-4578-bb2b-bd3f18f39e0e"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 605054000,
"epochSecond" : 1795102151
},
"deletedAt" : null,
"invited" : false,
"tags" : { },
"name" : "John Doe",
"status" : "ACTIVE",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}
Find User Identities
GET /user-identities
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
invited |
Boolean |
true |
|
tags |
Map |
true |
|
name |
String |
true |
|
status |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities' -i -X GET
Example response
HTTP/1.1 200 OK
Link: <https://gateway.netFoundry.io/identity/v1/user-identities?page=1>; rel="next", <https://gateway.netFoundry.io/identity/v1/user-identities?page=1>; rel="last"
Content-Type: application/json
Content-Length: 2366
[ {
"id" : "13d8c851-f988-468d-8db1-125e56f0ba79",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-358@acme.com",
"identityMappings" : [ {
"id" : "b7bb3759-e293-4787-8783-98f0931d3ef1",
"auth0UserId" : "auth0-opaque-userId-359",
"identityProviderId" : "da6e31cd-9ae3-4227-916b-d7c882bea2ae",
"userIdentityId" : "13d8c851-f988-468d-8db1-125e56f0ba79"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 533057000,
"epochSecond" : 1795102152
},
"deletedAt" : null,
"invited" : true,
"tags" : { },
"name" : "First Last",
"status" : "PENDING",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}, {
"id" : "23969361-2947-4560-a504-254f5a192494",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-355@acme.com",
"identityMappings" : [ {
"id" : "cd3dab0d-0e0d-4f33-9cb3-c665a76a9731",
"auth0UserId" : "auth0-opaque-userId-356",
"identityProviderId" : "da6e31cd-9ae3-4227-916b-d7c882bea2ae",
"userIdentityId" : "23969361-2947-4560-a504-254f5a192494"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 373328000,
"epochSecond" : 1795102152
},
"deletedAt" : null,
"invited" : true,
"tags" : { },
"name" : "First Last",
"status" : "PENDING",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}, {
"id" : "328950bf-3e61-4959-95ba-e82c9e6707ad",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-361@acme.com",
"identityMappings" : [ {
"id" : "3a0c50ac-c71c-4c2f-9ec8-7a3c20b9ec0a",
"auth0UserId" : "auth0|test-bcfda1eb-5589-4b83-9436-bdba1a038d85",
"identityProviderId" : "da6e31cd-9ae3-4227-916b-d7c882bea2ae",
"userIdentityId" : "328950bf-3e61-4959-95ba-e82c9e6707ad"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 581592000,
"epochSecond" : 1795102152
},
"deletedAt" : null,
"invited" : false,
"tags" : { },
"name" : "First Last",
"status" : "ACTIVE",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
} ]
Get User Identity
GET /user-identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
invited |
Boolean |
true |
|
tags |
Map |
true |
|
name |
String |
true |
|
status |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/550d268a-7008-4578-bb2b-bd3f18f39e0e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 772
{
"id" : "550d268a-7008-4578-bb2b-bd3f18f39e0e",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "117308ab-323b-4aac-99a0-e727c5eda752",
"auth0UserId" : "auth0-opaque-userId-336",
"identityProviderId" : "88aab295-b2bd-4ea1-acfb-80fd209202d3",
"userIdentityId" : "550d268a-7008-4578-bb2b-bd3f18f39e0e"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 605054000,
"epochSecond" : 1795102151
},
"deletedAt" : null,
"invited" : false,
"tags" : { },
"name" : "John Doe",
"status" : "ACTIVE",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}
Get User Identity By Mapping
GET /user-identities/mapping/{auth0UserId}/{identityProviderId}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
auth0UserId |
String |
false |
|
identityProviderId |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
invited |
Boolean |
true |
|
tags |
Map |
true |
|
name |
String |
true |
|
status |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/mapping/auth0-opaque-userId-336/88aab295-b2bd-4ea1-acfb-80fd209202d3' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 772
{
"id" : "550d268a-7008-4578-bb2b-bd3f18f39e0e",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@acme.com",
"identityMappings" : [ {
"id" : "117308ab-323b-4aac-99a0-e727c5eda752",
"auth0UserId" : "auth0-opaque-userId-336",
"identityProviderId" : "88aab295-b2bd-4ea1-acfb-80fd209202d3",
"userIdentityId" : "550d268a-7008-4578-bb2b-bd3f18f39e0e"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 605054000,
"epochSecond" : 1795102151
},
"deletedAt" : null,
"invited" : false,
"tags" : { },
"name" : "John Doe",
"status" : "ACTIVE",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}
Create Identity
POST /user-identities
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
tags |
Map |
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 |
|
invited |
Boolean |
true |
|
tags |
Map |
true |
|
name |
String |
true |
|
status |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com",
"tags" : null
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 539
{
"id" : "eb8dce0f-86cf-4f04-a676-9cda45c8968d",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "Jane",
"lastName" : "Doe",
"email" : "jane.doe@acme.com",
"identityMappings" : [ ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 714392000,
"epochSecond" : 1795102159
},
"deletedAt" : null,
"invited" : false,
"tags" : { },
"name" : "Jane Doe",
"status" : "ACTIVE",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}
Update
PUT /user-identities/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
tags |
Map |
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 |
|
invited |
Boolean |
true |
|
tags |
Map |
true |
|
name |
String |
true |
|
status |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/f3b59b5f-8392-476b-a9dd-1dc9baf93d9c' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com",
"tags" : null
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 781
{
"id" : "f3b59b5f-8392-476b-a9dd-1dc9baf93d9c",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "Bobby",
"lastName" : "White",
"email" : "bobby.white@acme.com",
"identityMappings" : [ {
"id" : "f078f571-04d7-450d-b1c2-30ba0a79e33d",
"auth0UserId" : "auth0-opaque-userId-480",
"identityProviderId" : "da6e31cd-9ae3-4227-916b-d7c882bea2ae",
"userIdentityId" : "f3b59b5f-8392-476b-a9dd-1dc9baf93d9c"
} ],
"identityAudienceMappings" : [ ],
"active" : true,
"createdAt" : {
"nano" : 234393000,
"epochSecond" : 1795102159
},
"deletedAt" : null,
"invited" : false,
"tags" : { },
"name" : "Bobby White",
"status" : "ACTIVE",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}
Activate Or Deactivate User Identity
PUT /user-identities/{id}/{action:activate|deactivate}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
firstName |
String |
true |
|
lastName |
String |
true |
|
String |
true |
||
identityMappings |
Array[Object] |
true |
|
identityMappings[].id |
String |
true |
|
identityMappings[].auth0UserId |
String |
true |
|
identityMappings[].identityProviderId |
String |
true |
|
identityMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings |
Array[Object] |
true |
|
identityAudienceMappings[].id |
String |
true |
|
identityAudienceMappings[].userIdentityId |
String |
true |
|
identityAudienceMappings[].oidcAudienceId |
String |
true |
|
identityAudienceMappings[].subject |
String |
true |
|
identityAudienceMappings[].active |
Boolean |
true |
|
identityAudienceMappings[].createdBy |
String |
true |
|
identityAudienceMappings[].createdAt |
Object |
true |
|
identityAudienceMappings[].deletedAt |
Object |
true |
|
identityAudienceMappings[].deletedBy |
String |
true |
|
identityAudienceMappings[].deleted |
Boolean |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
deletedAt |
Object |
true |
|
invited |
Boolean |
true |
|
tags |
Map |
true |
|
name |
String |
true |
|
status |
String |
true |
|
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/6d5104e0-4831-449c-b357-8e51947267bc/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 781
{
"id" : "6d5104e0-4831-449c-b357-8e51947267bc",
"organizationId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"firstName" : "First",
"lastName" : "Last",
"email" : "random-483@acme.com",
"identityMappings" : [ {
"id" : "acf0a66b-68b9-419d-b705-35a54eb83d1c",
"auth0UserId" : "auth0-opaque-userId-484",
"identityProviderId" : "da6e31cd-9ae3-4227-916b-d7c882bea2ae",
"userIdentityId" : "6d5104e0-4831-449c-b357-8e51947267bc"
} ],
"identityAudienceMappings" : [ ],
"active" : false,
"createdAt" : {
"nano" : 371449000,
"epochSecond" : 1795102159
},
"deletedAt" : null,
"invited" : false,
"tags" : { },
"name" : "First Last",
"status" : "INACTIVE",
"tenantId" : "b8c21f31-980e-40fc-8684-996b3ca3dc31",
"type" : "UserIdentity"
}
Reset User Identity Mfa Settings
PUT /user-identities/{id}/reset-mfa
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/e6b52eb2-94e8-4294-a216-183561c87a06/reset-mfa' -i -X PUT
Example response
HTTP/1.1 200 OK
Delete User Identity Passkeys
DELETE /user-identities/{id}/passkeys
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/53850129-94db-4867-ac52-e2499f0635b4/passkeys' -i -X DELETE
Example response
HTTP/1.1 204 No Content
Map Identity
POST /user-identities/{id}/mapping
Authorization
This endpoint requires:
-
create-identity-mappingaction on thisuser-identityresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
auth0UserId |
String |
true |
|
identityProviderId |
String |
true |
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/c14ad1d8-82f6-4701-bbb9-0909c8eac5bc/mapping' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"auth0UserId" : "new-auth0-userId:34929e6d-02a3-4186-bc0e-ffa5f0dd1374",
"identityProviderId" : "88aab295-b2bd-4ea1-acfb-80fd209202d3"
}'
Example response
HTTP/1.1 200 OK
API Account Identity
Find Api Account Identities
GET /api-account-identities
Query parameters
Supports standard paging query parameters.
| Parameter | Type | Optional | Description |
|---|---|---|---|
provider |
String |
true |
Must be one of [Auth0, Cognito]. |
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
tags |
Map |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities' -i -X GET
Example response
HTTP/1.1 200 OK
Link: <https://gateway.netFoundry.io/identity/v1/api-account-identities?page=1>; rel="next", <https://gateway.netFoundry.io/identity/v1/api-account-identities?page=2>; rel="last"
Content-Type: application/json
Content-Length: 2119
[ {
"id" : "3e133c83-509f-46f2-9b27-98bd1144306a",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ClientId" : "a1f7c94e-29cc-49ed-a52d-169607aa9b35",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "ACME Internal Service-22",
"contactEmail" : "service.admin-23@foo.com",
"description" : "updatable API Account description-24",
"active" : true,
"createdAt" : {
"nano" : 534169000,
"epochSecond" : 1795102096
},
"updatedAt" : null,
"deletedAt" : null,
"tags" : { },
"email" : "service.admin-23@foo.com",
"tenantId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"type" : "ApiAccountIdentity"
}, {
"id" : "46d5f78f-3967-40ec-a9c7-e002273aa520",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ClientId" : "ed0b6417-420f-4ada-8362-0b86c5ec9233",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "Robot",
"contactEmail" : "service.admin-13@foo.com",
"description" : "updatable API Account description-14",
"active" : true,
"createdAt" : {
"nano" : 924107000,
"epochSecond" : 1795102095
},
"updatedAt" : {
"nano" : 942324000,
"epochSecond" : 1795102095
},
"deletedAt" : null,
"tags" : { },
"email" : "service.admin-13@foo.com",
"tenantId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"type" : "ApiAccountIdentity"
}, {
"id" : "51e0aeb0-8cc2-488c-b826-2079a81f3f30",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ClientId" : "77e9cd99-36cc-4f59-8bec-b349de72c98b",
"awsCognitoClientId" : null,
"authenticationUrl" : "https://netfoundry-sandbox.auth0.com/oauth/token",
"name" : "HR Bridge Service",
"contactEmail" : "hr.director@acme.com",
"description" : "description goes here",
"active" : true,
"createdAt" : {
"nano" : 483077000,
"epochSecond" : 1795102098
},
"updatedAt" : null,
"deletedAt" : null,
"tags" : { },
"email" : "hr.director@acme.com",
"tenantId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"type" : "ApiAccountIdentity"
} ]
Get Api Account Identity
GET /api-account-identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
tags |
Map |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/a89a9e35-ae61-402e-bcd0-238c1396a329' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 733
{
"id" : "a89a9e35-ae61-402e-bcd0-238c1396a329",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ClientId" : "81f14898-db0c-445e-80fc-f94845f5f908",
"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" : 781309000,
"epochSecond" : 1795102092
},
"updatedAt" : {
"nano" : 39301000,
"epochSecond" : 1795102096
},
"deletedAt" : null,
"tags" : { },
"email" : "no-reply@acme.com",
"tenantId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"type" : "ApiAccountIdentity"
}
Get Api Account Identity By Mapping
GET /api-account-identities/mapping/{clientId}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
clientId |
String |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
tags |
Map |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/mapping/ec93fa46-e5e8-4767-9e1e-5b2d9ae094d1' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 698
{
"id" : "822f1169-3dec-4e91-b506-5ceb249a3e27",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ClientId" : "ec93fa46-e5e8-4767-9e1e-5b2d9ae094d1",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "ACME Internal Service-58",
"contactEmail" : "service.admin-59@foo.com",
"description" : "updatable API Account description-60",
"active" : true,
"createdAt" : {
"nano" : 747598000,
"epochSecond" : 1795102133
},
"updatedAt" : null,
"deletedAt" : null,
"tags" : { },
"email" : "service.admin-59@foo.com",
"tenantId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"type" : "ApiAccountIdentity"
}
Create Api Account Identity
POST /api-account-identities
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
organizationId |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
grantDefaultRoles |
Boolean |
true |
|
provider |
String |
true |
Must be one of [Auth0, Cognito]. |
tags |
Map |
true |
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.tags |
Map |
true |
|
apiAccountIdentity.email |
String |
true |
|
apiAccountIdentity.tenantId |
String |
true |
Deprecated.. |
apiAccountIdentity.type |
String |
true |
|
clientId |
String |
true |
|
password |
String |
true |
|
authenticationUrl |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"name" : "HR Bridge Service",
"contactEmail" : "hr.director@acme.com",
"description" : "description goes here",
"grantDefaultRoles" : true,
"provider" : "Cognito",
"tags" : null
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 958
{
"apiAccountIdentity" : {
"id" : "7d7b007a-6944-4eba-8131-dc85d35f7856",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ClientId" : null,
"awsCognitoClientId" : "6a3ccd42-e98a-4ad3-922a-0c28b73ffa53|fbxeifwv",
"authenticationUrl" : "https://netfoundry-test-aulwta.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" : 345134000,
"epochSecond" : 1795102098
},
"updatedAt" : null,
"deletedAt" : null,
"tags" : { },
"email" : "hr.director@acme.com",
"tenantId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"type" : "ApiAccountIdentity"
},
"clientId" : "fbxeifwv",
"password" : "gujmicekpbsivqoemvtjldpy",
"authenticationUrl" : "https://netfoundry-test-aulwta.auth.us-east-1.amazoncognito.com/oauth2/token"
}
Update Identity Info
PUT /api-account-identities/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
tags |
Map |
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 |
|
tags |
Map |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/fc5a12b5-029d-4d03-8a25-516a8a585f7a' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"name" : "Robot",
"contactEmail" : "robot@acme.com",
"description" : "description here.",
"tags" : null
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 696
{
"id" : "fc5a12b5-029d-4d03-8a25-516a8a585f7a",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ClientId" : "efd1f915-ac76-4739-bd49-312b675a8bb3",
"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" : 826902000,
"epochSecond" : 1795102092
},
"updatedAt" : {
"nano" : 509412000,
"epochSecond" : 1795102093
},
"deletedAt" : null,
"tags" : { },
"email" : "robot@acme.com",
"tenantId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"type" : "ApiAccountIdentity"
}
Activate Or Deactivate Api Account Identity
PUT /api-account-identities/{id}/{action:activate|deactivate}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
auth0ClientId |
String |
true |
|
awsCognitoClientId |
String |
true |
|
authenticationUrl |
String |
true |
|
name |
String |
true |
|
contactEmail |
String |
true |
|
description |
String |
true |
|
active |
Boolean |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedAt |
Object |
true |
|
tags |
Map |
true |
|
String |
true |
||
tenantId |
String |
true |
Deprecated.. |
type |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/2aebafc8-731c-4d7c-b430-d9fae2e83eb4/deactivate' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 755
{
"id" : "2aebafc8-731c-4d7c-b430-d9fae2e83eb4",
"organizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"auth0ClientId" : "bc25b829-5445-45de-b741-4de0e9e95342",
"awsCognitoClientId" : null,
"authenticationUrl" : "http://127.0.0.1:1234/IdP/OAuth2/login",
"name" : "ACME Internal Service-40",
"contactEmail" : "service.admin-41@foo.com",
"description" : "updatable API Account description-42",
"active" : false,
"createdAt" : {
"nano" : 474007000,
"epochSecond" : 1795102133
},
"updatedAt" : {
"nano" : 487962000,
"epochSecond" : 1795102133
},
"deletedAt" : null,
"tags" : { },
"email" : "service.admin-41@foo.com",
"tenantId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"type" : "ApiAccountIdentity"
}
Invitation
Find Invitations
GET /invitations
Query parameters
Supports standard paging query parameters.
| Parameter | Type | Optional | Description |
|---|---|---|---|
fromIdentityId |
Object |
true |
|
toTenantId |
Object |
true |
Deprecated.. |
toOrganizationId |
Object |
true |
|
invitedEmailAddress |
String |
true |
|
targetIdentityId |
Object |
true |
|
states |
Object |
true |
Must be one of [Open, Accepted, Declined, Expired, Revoked]. |
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
invitationHost |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1877
[ {
"id" : "0712346e-93f2-4228-adbe-62f268f3971c",
"fromIdentityId" : "d0a288d5-36b1-4194-a463-3bf175c7ad1b",
"toOrganizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"invitedEmailAddress" : "new.employee-296@acme.com",
"invitationHost" : "cloudziti.io",
"expiration" : {
"nano" : 638264000,
"epochSecond" : 1795706947
},
"targetUserIdentityId" : "d258773a-eaee-404c-9006-76d1b29c7367",
"accepted" : false,
"revokedAt" : null,
"responseReceivedAt" : {
"nano" : 661558000,
"epochSecond" : 1795102147
},
"state" : "Declined",
"toTenantId" : "771f425d-d424-43a9-920e-50abde2c91cb"
}, {
"id" : "8675a43f-7f06-4123-b209-8965b05ca8f9",
"fromIdentityId" : "d0a288d5-36b1-4194-a463-3bf175c7ad1b",
"toOrganizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"invitedEmailAddress" : "new.employee-303@acme.com",
"invitationHost" : "cloudziti.io",
"expiration" : {
"nano" : 833349000,
"epochSecond" : 1795706947
},
"targetUserIdentityId" : "8b80cf57-785f-4833-be85-2a3883a52fe2",
"accepted" : null,
"revokedAt" : {
"nano" : 858676000,
"epochSecond" : 1795102147
},
"responseReceivedAt" : {
"nano" : 858677000,
"epochSecond" : 1795102147
},
"state" : "Revoked",
"toTenantId" : "771f425d-d424-43a9-920e-50abde2c91cb"
}, {
"id" : "f2dc17a8-c9ae-4615-8ebc-dbf0742ead9c",
"fromIdentityId" : "ef39cf1c-3b45-430e-bdcb-bb6607768de1",
"toOrganizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"invitedEmailAddress" : "new.employee@acme.com",
"invitationHost" : "acme.cloudziti.io",
"expiration" : {
"nano" : 746612000,
"epochSecond" : 1795706947
},
"targetUserIdentityId" : "74e600f8-6d3a-4549-acef-aa5d1fca0e50",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "771f425d-d424-43a9-920e-50abde2c91cb"
} ]
Get Invitation By Id
GET /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
invitationHost |
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/4fcc897d-0ba2-42e5-8835-d73cad4d3790' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 564
{
"id" : "4fcc897d-0ba2-42e5-8835-d73cad4d3790",
"fromIdentityId" : "d0a288d5-36b1-4194-a463-3bf175c7ad1b",
"toOrganizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"invitedEmailAddress" : "new.employee-316@acme.com",
"invitationHost" : "cloudziti.io",
"expiration" : {
"nano" : 134265000,
"epochSecond" : 1795706948
},
"targetUserIdentityId" : "83eda22d-4732-45d3-ad5a-686d680566aa",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "771f425d-d424-43a9-920e-50abde2c91cb"
}
Create Invitation
POST /invitations
Authorization
This endpoint requires:
-
createaction on thisinvitationresource. -
readaction on theuser-identityresource identified by thetargetUserIdentityIdproperty.
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 |
|
invitationHost |
String |
true |
|
expiration |
Object |
true |
|
targetUserIdentityId |
String |
true |
|
accepted |
Boolean |
true |
|
revokedAt |
Object |
true |
|
responseReceivedAt |
Object |
true |
|
state |
String |
true |
|
toTenantId |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"toOrganizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"invitedEmailAddress" : "new.employee@acme.com",
"invitationUrl" : "http://acme.cloudziti.io/invitation",
"targetUserIdentityId" : "74e600f8-6d3a-4549-acef-aa5d1fca0e50"
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 565
{
"id" : "f2dc17a8-c9ae-4615-8ebc-dbf0742ead9c",
"fromIdentityId" : "ef39cf1c-3b45-430e-bdcb-bb6607768de1",
"toOrganizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"invitedEmailAddress" : "new.employee@acme.com",
"invitationHost" : "acme.cloudziti.io",
"expiration" : {
"nano" : 746612000,
"epochSecond" : 1795706947
},
"targetUserIdentityId" : "74e600f8-6d3a-4549-acef-aa5d1fca0e50",
"accepted" : null,
"revokedAt" : null,
"responseReceivedAt" : null,
"state" : "Open",
"toTenantId" : "771f425d-d424-43a9-920e-50abde2c91cb"
}
Respond To Invitation
PUT /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}/{action:accept|decline}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
|
action |
String |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
invitationHost |
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/71991e1c-7319-4d6e-b010-63a6e74954ec/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 621
{
"id" : "71991e1c-7319-4d6e-b010-63a6e74954ec",
"fromIdentityId" : "d0a288d5-36b1-4194-a463-3bf175c7ad1b",
"toOrganizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"invitedEmailAddress" : "new.employee-308@acme.com",
"invitationHost" : "cloudziti.io",
"expiration" : {
"nano" : 1205000,
"epochSecond" : 1795706948
},
"targetUserIdentityId" : "0ec843f2-9245-413f-9024-f7b608461bcd",
"accepted" : false,
"revokedAt" : null,
"responseReceivedAt" : {
"nano" : 9510000,
"epochSecond" : 1795102148
},
"state" : "Declined",
"toTenantId" : "771f425d-d424-43a9-920e-50abde2c91cb"
}
Revoke Invitation
PUT /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}/revoke
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
fromIdentityId |
String |
true |
|
toOrganizationId |
String |
true |
|
invitedEmailAddress |
String |
true |
|
invitationHost |
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/3c64f35c-2c33-406a-8fc6-343576b76cfa/revoke' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 679
{
"id" : "3c64f35c-2c33-406a-8fc6-343576b76cfa",
"fromIdentityId" : "d0a288d5-36b1-4194-a463-3bf175c7ad1b",
"toOrganizationId" : "771f425d-d424-43a9-920e-50abde2c91cb",
"invitedEmailAddress" : "new.employee-324@acme.com",
"invitationHost" : "cloudziti.io",
"expiration" : {
"nano" : 255687000,
"epochSecond" : 1795706948
},
"targetUserIdentityId" : "5ffdfd71-811f-44c7-bce3-7f7a86582ef8",
"accepted" : null,
"revokedAt" : {
"nano" : 264264000,
"epochSecond" : 1795102148
},
"responseReceivedAt" : {
"nano" : 264266000,
"epochSecond" : 1795102148
},
"state" : "Revoked",
"toTenantId" : "771f425d-d424-43a9-920e-50abde2c91cb"
}
Support
Create Support Request
POST /nfconsole/support/requests
Authorization
Authorization not required for this request.
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
name |
String |
true |
|
String |
true |
||
selectedOrganizationId |
String |
true |
|
selectedNetworkId |
String |
true |
|
subject |
String |
true |
|
comment |
String |
true |
|
type |
String |
true |
Must be one of [problem, incident, question, task]. |
priority |
String |
true |
Must be one of [urgent, high, normal, low]. |
severity |
String |
true |
Must be one of [Severity1, Severity2, Severity3]. |
recentErrorMessages |
Array[String] |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/nfconsole/support/requests' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"name" : "Curious George",
"email" : "george@curious-client.com",
"selectedOrganizationId" : null,
"selectedNetworkId" : null,
"subject" : "Sales Contact Request",
"comment" : "This looks great! I'd like a sales rep to contact me.",
"type" : "question",
"priority" : "high",
"severity" : "Severity3",
"recentErrorMessages" : null
}'
Example response
HTTP/1.1 200 OK
Invitation Flow
Get Invitation By Key
GET /invitations/key/{key:\p{Alnum}{36}}
Authorization
Authorization not required for this request.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
key |
String |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
fromIdentity |
Object |
true |
|
fromIdentity.name |
String |
true |
|
fromIdentity.email |
String |
true |
|
targetIdentity |
Object |
true |
|
targetIdentity.name |
String |
true |
|
targetIdentity.email |
String |
true |
|
invitedEmailAddress |
String |
true |
|
toOrganizationName |
String |
true |
|
toOrganizationLabel |
String |
true |
|
expiration |
Object |
true |
|
accepted |
Boolean |
true |
|
state |
String |
true |
Must be one of [Open, Accepted, Declined, Expired, Revoked]. |
toTenantName |
String |
true |
Deprecated.. |
toTenantLabel |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/key/VcoyjaosxsbHje7veeaXnXyP6ViYlfUD5Kwr' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 523
{
"fromIdentity" : {
"name" : "John Doe",
"email" : "john.doe@acme.com"
},
"targetIdentity" : {
"name" : "First Last",
"email" : "random-358@acme.com"
},
"invitedEmailAddress" : "new.employee-360@acme.com",
"toOrganizationName" : "ACME International, Inc.",
"toOrganizationLabel" : "ACME-333",
"expiration" : {
"nano" : 537723000,
"epochSecond" : 1795706952
},
"accepted" : null,
"state" : "Open",
"toTenantName" : "ACME International, Inc.",
"toTenantLabel" : "ACME-333"
}
Decline Invitation
PUT /invitations/key/{key:\p{Alnum}{36}}/decline
Authorization
Authorization not required for this request.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
key |
String |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
fromIdentity |
Object |
true |
|
fromIdentity.name |
String |
true |
|
fromIdentity.email |
String |
true |
|
targetIdentity |
Object |
true |
|
targetIdentity.name |
String |
true |
|
targetIdentity.email |
String |
true |
|
invitedEmailAddress |
String |
true |
|
toOrganizationName |
String |
true |
|
toOrganizationLabel |
String |
true |
|
expiration |
Object |
true |
|
accepted |
Boolean |
true |
|
state |
String |
true |
Must be one of [Open, Accepted, Declined, Expired, Revoked]. |
toTenantName |
String |
true |
Deprecated.. |
toTenantLabel |
String |
true |
Deprecated.. |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/key/RNA8RIPvNDJs7qOXEVQh1mfu1EANtdwjkVuO/decline' -i -X PUT
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 527
{
"fromIdentity" : {
"name" : "John Doe",
"email" : "john.doe@acme.com"
},
"targetIdentity" : {
"name" : "First Last",
"email" : "random-343@acme.com"
},
"invitedEmailAddress" : "new.employee-345@acme.com",
"toOrganizationName" : "ACME International, Inc.",
"toOrganizationLabel" : "ACME-333",
"expiration" : {
"nano" : 98791000,
"epochSecond" : 1795706952
},
"accepted" : false,
"state" : "Declined",
"toTenantName" : "ACME International, Inc.",
"toTenantLabel" : "ACME-333"
}
Initiate Accept Invitation
POST /invitations/key/{key:\p{Alnum}{36}}/accept-initiate
Authorization
Authorization not required for this request.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
key |
String |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
intermediateReturnUrl |
String |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
nfToken |
String |
true |
|
auth0ConnectionIds |
Array[String] |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/invitations/key/GOl5F4Zew1kck2f3LcE3ZToHyz2rAgSkuygi/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: 987
{
"nfToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3OTUxMDIxNTIsImV4cCI6MTc5NTEwMzA1MiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiZmxvdyI6Imludml0YXRpb24iLCJpbnZpdGF0aW9uSWQiOiI3M2M2ZDVlYi1mMmYzLTRhMjAtYmYxYi0wNjRhNmI3NGVlZTkiLCJ0ZW5hbnRMYWJlbCI6IkFDTUUtMzMzIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMzM1IiwiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0zMzQiXSwicmVkaXJlY3RVcmwiOiJodHRwOi8vY29uc29sZS5uZmFkbWluLm5ldGZvdW5kcnkuaW8vaW52aXRhdGlvbiJ9.riy6cb_MSXK3R0uyslV647PqbuqfDib0aZ4J5mnUfs3R6jd6jpvvWyWsAi3YqFHrSP9oTGEyWn-AUJW3zD-Z7nALU9V6wv750c-0NTWqgRGfQppDgCyIMJB0Ietkdkh9BmXQ8FmbOXWajulF2Il9-AflkgkY_1mif0l8sPywrOlBYaz9TncRX7Rn0C6c6QQCx6Ci8UWReWevYi6zGh7S2dnL7BiGN8u6yDGhGyk8iPSFtlwn26df8Hg814dVi5vH3astUkd4ypTW0hP-y8xeS--HRUeY2tXil4oGCDX3ks3j2vIzLFAozjlIzIRs7WATVvGuLzFNQXw17gDnn9mbEg",
"auth0ConnectionIds" : [ "auth0-opaque-connectionId-335", "auth0-opaque-connectionId-334" ]
}
Login Flow
Initiate Interactive Authorization
POST /organizations/authorize-initiate
Authorization
Authorization not required for this request.
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
realmLabel |
String |
true |
|
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 '{
"realmLabel" : "netfoundry",
"label" : "ACME-2",
"intermediateReturnUrl" : "http://console.nfadmin.netfoundry.io/invitation"
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 902
{
"nfToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3OTUxMDIxNTIsImV4cCI6MTc5NTEwMzA1MiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJsb2dpbiIsInRlbmFudExhYmVsIjoiQUNNRS0yIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtNCIsImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMyJdLCJyZWRpcmVjdFVybCI6Imh0dHA6Ly9jb25zb2xlLm5mYWRtaW4ubmV0Zm91bmRyeS5pby9pbnZpdGF0aW9uIn0.U96S-6DOntxfkEf_crvBRKrUYFUNzPAdStQqkPsohwWP4UzYcJaQoFFHycpEfgxRZFRmJPI60WDKpiyaIHfyjwgMWz4bO2CAedAPamw-gMfV93IRj9YGB1nOUkFs-0nqziLclizdRx7fQ2y4rcPBIZqcWqbma-1jaoOj8SgK-VrvTHRFE3RZn_uUbjyySbdQAE2F6sZM8yz3pdYkjAi29PM0o6ZIMa7Bzd-XhvN54FD_K5-4ciR1q3EFYzVvUtSgEX9dzjzEOm_vTaUSo9fFiaPuvKXf7e-oew3b25Wo0orRIToNWUzSz_x9ZM-QlRsxqN78ydwIUC12CDd9BSjsWg",
"auth0ConnectionIds" : [ "auth0-opaque-connectionId-4", "auth0-opaque-connectionId-3" ]
}
Identity Preference Flow
Find Identity Preferences
GET /identity-preferences
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1298
[ {
"id" : "2e6931a7-ee0f-41d1-98fd-c435c1a2a4d7",
"userIdentityId" : "45ca53a8-5109-4e53-94c5-aae5a2bb82b5",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "45ca53a8-5109-4e53-94c5-aae5a2bb82b5",
"createdAt" : {
"nano" : 585958000,
"epochSecond" : 1795102144
},
"updatedAt" : {
"nano" : 585958000,
"epochSecond" : 1795102144
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "58f54c85-1471-4a1a-a93a-9b8a4dc4bc1b",
"userIdentityId" : "82b083da-7ffd-48c8-83e4-1a886d8941e2",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "82b083da-7ffd-48c8-83e4-1a886d8941e2",
"createdAt" : {
"nano" : 695057000,
"epochSecond" : 1795102144
},
"updatedAt" : {
"nano" : 695057000,
"epochSecond" : 1795102144
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "c9dfa57f-cffa-4c15-8c38-de2d7c50f365",
"userIdentityId" : "534c5336-5def-40b1-b53d-2b515bc612b4",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "534c5336-5def-40b1-b53d-2b515bc612b4",
"createdAt" : {
"nano" : 643207000,
"epochSecond" : 1795102144
},
"updatedAt" : {
"nano" : 643207000,
"epochSecond" : 1795102144
},
"deletedBy" : null,
"deletedAt" : null
} ]
Get Identity Preference
GET /identity-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences/c7e0c11b-41d8-4906-8e35-05ba5da1905e' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "c7e0c11b-41d8-4906-8e35-05ba5da1905e",
"userIdentityId" : "f5aa4919-a88c-45cc-bfbc-2ad150ee534e",
"preferences" : {
"hello" : "world"
},
"createdBy" : "f5aa4919-a88c-45cc-bfbc-2ad150ee534e",
"createdAt" : {
"nano" : 795061000,
"epochSecond" : 1795102145
},
"updatedAt" : {
"nano" : 795061000,
"epochSecond" : 1795102145
},
"deletedBy" : null,
"deletedAt" : null
}
Upsert Identity Preference
POST /identity-preferences
Authorization
This endpoint requires no specific permission, only an authenticated client.
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"userIdentityId" : null,
"preferences" : {
"first" : "my first preference."
}
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430
{
"id" : "ac84cf5f-1137-43df-a649-c8a8b9214df1",
"userIdentityId" : "32bb1990-a7ba-4e23-896b-e51fe8328b4d",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "32bb1990-a7ba-4e23-896b-e51fe8328b4d",
"createdAt" : {
"nano" : 147297000,
"epochSecond" : 1795102145
},
"updatedAt" : {
"nano" : 147297000,
"epochSecond" : 1795102145
},
"deletedBy" : null,
"deletedAt" : null
}
Upsert Identity Preference By Id
PUT /identity-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Authorization
This endpoint requires:
-
createaction on thisidentity-preferenceresource. -
updateaction on thisidentity-preferenceresource.
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences/d5211867-8d10-4179-84fa-a6caad3bfdf0' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"preferences" : {
"updated" : "my second preference."
}
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 433
{
"id" : "d5211867-8d10-4179-84fa-a6caad3bfdf0",
"userIdentityId" : "fc71703c-bd3b-405a-af41-e3420fb41551",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "fc71703c-bd3b-405a-af41-e3420fb41551",
"createdAt" : {
"nano" : 641844000,
"epochSecond" : 1795102146
},
"updatedAt" : {
"nano" : 654223000,
"epochSecond" : 1795102146
},
"deletedBy" : null,
"deletedAt" : null
}
Delete Identity Preference By Id
DELETE /identity-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
userIdentityId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences/a94a1764-a192-4b17-900d-d2385aa3287a' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "a94a1764-a192-4b17-900d-d2385aa3287a",
"userIdentityId" : "330a2761-6648-40d7-acf6-a7655600aaa9",
"preferences" : {
"hello" : "world"
},
"createdBy" : "330a2761-6648-40d7-acf6-a7655600aaa9",
"createdAt" : {
"nano" : 436695000,
"epochSecond" : 1795102145
},
"updatedAt" : {
"nano" : 449042000,
"epochSecond" : 1795102145
},
"deletedBy" : "858fe0d3-509b-4cbb-a193-fec5b6b0a69e",
"deletedAt" : {
"nano" : 448000000,
"epochSecond" : 1795102145
}
}
Organization Preference Flow
Find Organization Preferences
GET /organization-preferences
Response fields
Standard paging response where content field is list of following objects:
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1262
[ {
"id" : "241b3f30-7f4c-4863-9a14-0a7b28a4099c",
"organizationId" : "bc00dd22-a842-4fbc-b8fe-1d1e9c09650e",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "acee0bcf-1302-4bd6-80d2-acc0aabdf973",
"createdAt" : {
"nano" : 89819000,
"epochSecond" : 1795102157
},
"updatedAt" : {
"nano" : 89819000,
"epochSecond" : 1795102157
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "5a4b9240-a862-4635-b268-6f210dee9c98",
"organizationId" : "de4ccc1a-eeaa-4117-b571-6ee94718855e",
"preferences" : {
"hello" : "world"
},
"createdBy" : "ef51541c-d6de-48fc-9c4c-a00801a30d8f",
"createdAt" : {
"nano" : 209967000,
"epochSecond" : 1795102157
},
"updatedAt" : {
"nano" : 209967000,
"epochSecond" : 1795102157
},
"deletedBy" : null,
"deletedAt" : null
}, {
"id" : "a71d5a00-76db-4903-963e-3ac3391c9f2a",
"organizationId" : "343a8741-8263-4a9f-89a5-37c5b4db6e34",
"preferences" : {
"hello" : "world"
},
"createdBy" : "8095b80e-a0b3-483a-9be8-6b9de7718638",
"createdAt" : {
"nano" : 1431000,
"epochSecond" : 1795102157
},
"updatedAt" : {
"nano" : 1431000,
"epochSecond" : 1795102157
},
"deletedBy" : null,
"deletedAt" : null
} ]
Get Organization Preference
GET /organization-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences/5a4b9240-a862-4635-b268-6f210dee9c98' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415
{
"id" : "5a4b9240-a862-4635-b268-6f210dee9c98",
"organizationId" : "de4ccc1a-eeaa-4117-b571-6ee94718855e",
"preferences" : {
"hello" : "world"
},
"createdBy" : "ef51541c-d6de-48fc-9c4c-a00801a30d8f",
"createdAt" : {
"nano" : 209967000,
"epochSecond" : 1795102157
},
"updatedAt" : {
"nano" : 209967000,
"epochSecond" : 1795102157
},
"deletedBy" : null,
"deletedAt" : null
}
Create Organization Preference
POST /organization-preferences
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
organizationId |
String |
true |
|
preferences |
Object |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"organizationId" : "bc00dd22-a842-4fbc-b8fe-1d1e9c09650e",
"preferences" : {
"first" : "my first preference."
}
}'
Example response
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 428
{
"id" : "241b3f30-7f4c-4863-9a14-0a7b28a4099c",
"organizationId" : "bc00dd22-a842-4fbc-b8fe-1d1e9c09650e",
"preferences" : {
"first" : "my first preference."
},
"createdBy" : "acee0bcf-1302-4bd6-80d2-acc0aabdf973",
"createdAt" : {
"nano" : 89819000,
"epochSecond" : 1795102157
},
"updatedAt" : {
"nano" : 89819000,
"epochSecond" : 1795102157
},
"deletedBy" : null,
"deletedAt" : null
}
Update Organization Preference
PUT /organization-preferences/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Request fields
| Path | Type | Optional | Description |
|---|---|---|---|
preferences |
Object |
true |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences/724b5405-1889-4799-b89b-d6122e9d75ef' -i -X PUT \
-H 'Content-Type: application/json' \
-d '{
"preferences" : {
"updated" : "my second preference."
}
}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 433
{
"id" : "724b5405-1889-4799-b89b-d6122e9d75ef",
"organizationId" : "2c1d8375-102d-4316-a7f4-f456cd2474c5",
"preferences" : {
"updated" : "my second preference."
},
"createdBy" : "908e934e-6db1-4c36-bf1e-41b140e77e54",
"createdAt" : {
"nano" : 343390000,
"epochSecond" : 1795102157
},
"updatedAt" : {
"nano" : 371328000,
"epochSecond" : 1795102157
},
"deletedBy" : null,
"deletedAt" : null
}
Delete Organization Preference
DELETE /organization-preferences/{id}
Path parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
id |
Object |
false |
Response fields
| Path | Type | Optional | Description |
|---|---|---|---|
id |
String |
true |
|
organizationId |
String |
true |
|
preferences |
Object |
true |
|
createdBy |
String |
true |
|
createdAt |
Object |
true |
|
updatedAt |
Object |
true |
|
deletedBy |
String |
true |
|
deletedAt |
Object |
true |
Example request
$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences/e06bf8bc-928b-4c47-919f-0bcbeb92d963' -i -X DELETE
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505
{
"id" : "e06bf8bc-928b-4c47-919f-0bcbeb92d963",
"organizationId" : "606e226a-5e04-4257-8dc6-76c3cda8f42f",
"preferences" : {
"hello" : "world"
},
"createdBy" : "233dd4fa-ae5c-4d48-8cee-94ac438e0164",
"createdAt" : {
"nano" : 149976000,
"epochSecond" : 1795102157
},
"updatedAt" : {
"nano" : 165164000,
"epochSecond" : 1795102157
},
"deletedBy" : "1ac802d5-2ade-4d1e-b311-1b7ca7681816",
"deletedAt" : {
"nano" : 163000000,
"epochSecond" : 1795102157
}
}