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

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

DELETE

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

200 OK

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.

201 Created

The request has been fulfilled and resulted in a new resource being created.

202 Accepted

The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services.

204 No Content

The server successfully processed the request, but is not returning any content.

400 Bad Request

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).

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

Resources

Organization

Find Organizations

GET /organizations

Authorization

This endpoint requires:

  • read action on this organization resource.

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: 2490

[ {
  "id" : "26da840e-8606-4faa-b629-a25f243144dc",
  "realmId" : "a4c452ac-bc1f-4c7d-817c-e2b23b0c6743",
  "name" : "World Wide Imports",
  "label" : "WW-Imports-184",
  "identityProviders" : [ {
    "id" : "6322ca0f-cb72-42ef-8a68-e21f4acf99f3",
    "organizationId" : "26da840e-8606-4faa-b629-a25f243144dc",
    "auth0ConnectionId" : "auth0-opaque-connectionId-185",
    "name" : "Username/Password",
    "auth0ConnectionType" : "Database",
    "active" : true,
    "createdAt" : {
      "nano" : 532547000,
      "epochSecond" : 1792735475
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "defaultRoles" : [ ],
  "active" : true,
  "mfaProvider" : null,
  "createdAt" : {
    "nano" : 530724000,
    "epochSecond" : 1792735475
  },
  "updatedAt" : null,
  "deletedBy" : null,
  "deletedAt" : null,
  "deleted" : false
}, {
  "id" : "3ce00a2c-96a7-4664-98ad-a103d88f08e3",
  "realmId" : "76553dee-5dea-4e5d-aa1d-a95ce92576dd",
  "name" : "Best Corp.",
  "label" : "BEST-CORP",
  "identityProviders" : [ {
    "id" : "be151f6b-7a46-4de2-9664-a65881aafb4e",
    "organizationId" : "3ce00a2c-96a7-4664-98ad-a103d88f08e3",
    "auth0ConnectionId" : "auth0-opaque-connection",
    "name" : "Best Corp.",
    "auth0ConnectionType" : "Enterprise",
    "active" : true,
    "createdAt" : {
      "nano" : 19482000,
      "epochSecond" : 1792735486
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "defaultRoles" : [ ],
  "active" : true,
  "mfaProvider" : null,
  "createdAt" : {
    "nano" : 18605000,
    "epochSecond" : 1792735486
  },
  "updatedAt" : null,
  "deletedBy" : null,
  "deletedAt" : null,
  "deleted" : false
}, {
  "id" : "5a08c2db-0469-4f0d-8abe-e5fc4ce6fc75",
  "realmId" : "a4c452ac-bc1f-4c7d-817c-e2b23b0c6743",
  "name" : "World Wide Imports",
  "label" : "WW-Imports-261",
  "identityProviders" : [ {
    "id" : "4a23fa13-f42f-4a86-b14d-458fcfdcf8b8",
    "organizationId" : "5a08c2db-0469-4f0d-8abe-e5fc4ce6fc75",
    "auth0ConnectionId" : "auth0-opaque-connectionId-262",
    "name" : "Username/Password",
    "auth0ConnectionType" : "Database",
    "active" : true,
    "createdAt" : {
      "nano" : 327016000,
      "epochSecond" : 1792735477
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "defaultRoles" : [ ],
  "active" : true,
  "mfaProvider" : null,
  "createdAt" : {
    "nano" : 325320000,
    "epochSecond" : 1792735477
  },
  "updatedAt" : null,
  "deletedBy" : null,
  "deletedAt" : null,
  "deleted" : false
} ]

Get Organization By Self

GET /organizations/self

Authorization

This endpoint requires:

  • read action on this organization resource.

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: 2218

{
  "id" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "realmId" : "2b551792-324e-4200-ab38-3d17f27ac13d",
  "name" : "ACME International, Inc.",
  "label" : "ACME-2",
  "identityProviders" : [ {
    "id" : "1386fc52-1786-4ea3-8056-f340502a2334",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "auth0ConnectionId" : "auth0-opaque-connectionId-3",
    "name" : "ACME Federated Active Directory",
    "auth0ConnectionType" : "Enterprise",
    "active" : true,
    "createdAt" : {
      "nano" : 957616000,
      "epochSecond" : 1792735421
    },
    "updatedAt" : null,
    "deletedAt" : null
  }, {
    "id" : "1184458a-7479-4080-9fd7-63f502919ace",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "auth0ConnectionId" : "auth0-opaque-connectionId-4",
    "name" : "Google-Account",
    "auth0ConnectionType" : "Social",
    "active" : true,
    "createdAt" : {
      "nano" : 965823000,
      "epochSecond" : 1792735421
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "defaultRoles" : [ {
    "id" : "aeeeb74b-7ae1-49cd-a751-5d7e1d24a6a2",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "name" : "Standard Role - 2c9de0d8-1817-4b31-aa3c-3bb51f6015e5",
    "roleType" : "Standard",
    "roleId" : "2c9de0d8-1817-4b31-aa3c-3bb51f6015e5",
    "createdBy" : "4fdb9cfe-6804-467a-b38d-a4f808cd17ca",
    "createdAt" : {
      "nano" : 36221000,
      "epochSecond" : 1792735422
    },
    "deletedAt" : null,
    "deletedBy" : null,
    "deleted" : false
  }, {
    "id" : "17299b6d-244c-44a7-ba00-1b948e0a8d13",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "name" : "Custom Role - f88b4c6e-e4fc-4471-9fc8-262708d0a955",
    "roleType" : "Custom",
    "roleId" : "f88b4c6e-e4fc-4471-9fc8-262708d0a955",
    "createdBy" : "32e13fb7-c90b-4d37-89f0-8cb8cf23d22a",
    "createdAt" : {
      "nano" : 47152000,
      "epochSecond" : 1792735422
    },
    "deletedAt" : null,
    "deletedBy" : null,
    "deleted" : false
  } ],
  "active" : true,
  "mfaProvider" : null,
  "createdAt" : {
    "nano" : 953161000,
    "epochSecond" : 1792735421
  },
  "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}}

Authorization

This endpoint requires:

  • read action on this organization resource.

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/98e5b6a6-d7de-4afd-9bdf-219657ce495c' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2218

{
  "id" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "realmId" : "2b551792-324e-4200-ab38-3d17f27ac13d",
  "name" : "ACME International, Inc.",
  "label" : "ACME-2",
  "identityProviders" : [ {
    "id" : "1386fc52-1786-4ea3-8056-f340502a2334",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "auth0ConnectionId" : "auth0-opaque-connectionId-3",
    "name" : "ACME Federated Active Directory",
    "auth0ConnectionType" : "Enterprise",
    "active" : true,
    "createdAt" : {
      "nano" : 957616000,
      "epochSecond" : 1792735421
    },
    "updatedAt" : null,
    "deletedAt" : null
  }, {
    "id" : "1184458a-7479-4080-9fd7-63f502919ace",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "auth0ConnectionId" : "auth0-opaque-connectionId-4",
    "name" : "Google-Account",
    "auth0ConnectionType" : "Social",
    "active" : true,
    "createdAt" : {
      "nano" : 965823000,
      "epochSecond" : 1792735421
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "defaultRoles" : [ {
    "id" : "aeeeb74b-7ae1-49cd-a751-5d7e1d24a6a2",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "name" : "Standard Role - 2c9de0d8-1817-4b31-aa3c-3bb51f6015e5",
    "roleType" : "Standard",
    "roleId" : "2c9de0d8-1817-4b31-aa3c-3bb51f6015e5",
    "createdBy" : "4fdb9cfe-6804-467a-b38d-a4f808cd17ca",
    "createdAt" : {
      "nano" : 36221000,
      "epochSecond" : 1792735422
    },
    "deletedAt" : null,
    "deletedBy" : null,
    "deleted" : false
  }, {
    "id" : "17299b6d-244c-44a7-ba00-1b948e0a8d13",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "name" : "Custom Role - f88b4c6e-e4fc-4471-9fc8-262708d0a955",
    "roleType" : "Custom",
    "roleId" : "f88b4c6e-e4fc-4471-9fc8-262708d0a955",
    "createdBy" : "32e13fb7-c90b-4d37-89f0-8cb8cf23d22a",
    "createdAt" : {
      "nano" : 47152000,
      "epochSecond" : 1792735422
    },
    "deletedAt" : null,
    "deletedBy" : null,
    "deleted" : false
  } ],
  "active" : true,
  "mfaProvider" : null,
  "createdAt" : {
    "nano" : 953161000,
    "epochSecond" : 1792735421
  },
  "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}}

Authorization

This endpoint requires:

  • read action on this organization resource.

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" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "realmId" : "2b551792-324e-4200-ab38-3d17f27ac13d",
  "name" : "ACME International, Inc.",
  "label" : "ACME-2",
  "active" : true,
  "identityProviders" : [ {
    "id" : "1386fc52-1786-4ea3-8056-f340502a2334",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "auth0ConnectionId" : "auth0-opaque-connectionId-3",
    "name" : "ACME Federated Active Directory",
    "auth0ConnectionType" : "Enterprise",
    "active" : true,
    "createdAt" : {
      "nano" : 957616000,
      "epochSecond" : 1792735421
    },
    "updatedAt" : null,
    "deletedAt" : null
  }, {
    "id" : "1184458a-7479-4080-9fd7-63f502919ace",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "auth0ConnectionId" : "auth0-opaque-connectionId-4",
    "name" : "Google-Account",
    "auth0ConnectionType" : "Social",
    "active" : true,
    "createdAt" : {
      "nano" : 965823000,
      "epochSecond" : 1792735421
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "mfaProvider" : null
}

Create Organization

POST /organizations

Authorization

This endpoint requires:

  • create action on this organization resource.

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" : "76553dee-5dea-4e5d-aa1d-a95ce92576dd",
  "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: 810

{
  "id" : "3ce00a2c-96a7-4664-98ad-a103d88f08e3",
  "realmId" : "76553dee-5dea-4e5d-aa1d-a95ce92576dd",
  "name" : "Best Corp.",
  "label" : "BEST-CORP",
  "identityProviders" : [ {
    "id" : "be151f6b-7a46-4de2-9664-a65881aafb4e",
    "organizationId" : "3ce00a2c-96a7-4664-98ad-a103d88f08e3",
    "auth0ConnectionId" : "auth0-opaque-connection",
    "name" : "Best Corp.",
    "auth0ConnectionType" : "Enterprise",
    "active" : true,
    "createdAt" : {
      "nano" : 19482000,
      "epochSecond" : 1792735486
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "defaultRoles" : [ ],
  "active" : true,
  "mfaProvider" : null,
  "createdAt" : {
    "nano" : 18605000,
    "epochSecond" : 1792735486
  },
  "updatedAt" : null,
  "deletedBy" : null,
  "deletedAt" : null,
  "deleted" : false
}

Activate Or Deactivate Organization

PUT /organizations/{id}/{action:activate|deactivate}

Authorization

This endpoint requires:

  • update-active action on this organization resource.

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/12df7725-4c58-4752-8474-6aab1c6fc974/deactivate' -i -X PUT

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 893

{
  "id" : "12df7725-4c58-4752-8474-6aab1c6fc974",
  "realmId" : "a4c452ac-bc1f-4c7d-817c-e2b23b0c6743",
  "name" : "World Wide Imports",
  "label" : "WW-Imports-382",
  "identityProviders" : [ {
    "id" : "66974cb2-55e4-49f5-87d6-fa0e38ece363",
    "organizationId" : "12df7725-4c58-4752-8474-6aab1c6fc974",
    "auth0ConnectionId" : "auth0-opaque-connectionId-383",
    "name" : "Username/Password",
    "auth0ConnectionType" : "Database",
    "active" : true,
    "createdAt" : {
      "nano" : 989773000,
      "epochSecond" : 1792735486
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "defaultRoles" : [ ],
  "active" : false,
  "mfaProvider" : null,
  "createdAt" : {
    "nano" : 988671000,
    "epochSecond" : 1792735486
  },
  "updatedAt" : {
    "nano" : 999811000,
    "epochSecond" : 1792735486
  },
  "deletedBy" : null,
  "deletedAt" : null,
  "deleted" : false
}

Add Identity Provider

POST /organizations/{id}/identity-providers

Authorization

This endpoint requires:

  • create-identity-provider action on this organization resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Request fields

Path Type Optional Description

auth0ConnectionId

String

true

identityProviderName

String

true

auth0ConnectionType

String

true

Must be one of [Database, Social, Enterprise, Passwordless].

Response fields

Path Type Optional Description

id

String

true

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/c26cccd3-0231-4db3-9acf-bfae95c6643c/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" : "c26cccd3-0231-4db3-9acf-bfae95c6643c",
  "realmId" : "a4c452ac-bc1f-4c7d-817c-e2b23b0c6743",
  "name" : "World Wide Imports",
  "label" : "WW-Imports-378",
  "identityProviders" : [ {
    "id" : "6d49bbbe-6e53-4b1e-a84c-646aa3558e66",
    "organizationId" : "c26cccd3-0231-4db3-9acf-bfae95c6643c",
    "auth0ConnectionId" : "auth0-opaque-connectionId-379",
    "name" : "Username/Password",
    "auth0ConnectionType" : "Database",
    "active" : true,
    "createdAt" : {
      "nano" : 823086000,
      "epochSecond" : 1792735486
    },
    "updatedAt" : null,
    "deletedAt" : null
  }, {
    "id" : "31492823-e516-4d37-86b5-f18158e3aa4a",
    "organizationId" : "c26cccd3-0231-4db3-9acf-bfae95c6643c",
    "auth0ConnectionId" : "auth0-opaque-connection",
    "name" : "Corp SAML",
    "auth0ConnectionType" : "Enterprise",
    "active" : true,
    "createdAt" : {
      "nano" : 848884000,
      "epochSecond" : 1792735486
    },
    "updatedAt" : null,
    "deletedAt" : null
  } ],
  "defaultRoles" : [ ],
  "active" : true,
  "mfaProvider" : null,
  "createdAt" : {
    "nano" : 821719000,
    "epochSecond" : 1792735486
  },
  "updatedAt" : null,
  "deletedBy" : null,
  "deletedAt" : null,
  "deleted" : false
}

OIDC Issuers

Find Oidc Issuers

GET /oidc-issuers

Authorization

This endpoint requires:

  • read action on this oidc-issuer resource.

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" : "12df3744-cc37-4158-a039-a026367b7274",
  "issuer" : "https://ed638e28-1f62-493a-8da2-d6f7adc77887.issuer.idp",
  "jwksUri" : "https://ed638e28-1f62-493a-8da2-d6f7adc77887.issuer.idp/jwks",
  "active" : true,
  "createdBy" : "c7c1220a-e151-4f82-aa32-c77023f2999a",
  "createdAt" : {
    "nano" : 513647000,
    "epochSecond" : 1792735484
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}, {
  "id" : "316d0778-6e56-4a67-9c56-3bcb010ea0f7",
  "issuer" : "https://0e54b6f9-d560-4310-9ec2-a623f436f019.issuer.idp",
  "jwksUri" : "https://0e54b6f9-d560-4310-9ec2-a623f436f019.issuer.idp/jwks",
  "active" : true,
  "createdBy" : "790a5f0a-7ba2-4156-bf21-3f343ebc1d5c",
  "createdAt" : {
    "nano" : 623909000,
    "epochSecond" : 1792735484
  },
  "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" : 80659000,
    "epochSecond" : 1792735418
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
} ]

Get Oidc Issuer

GET /oidc-issuers/{id}

Authorization

This endpoint requires:

  • read action on this oidc-issuer resource.

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/867c110b-397e-42aa-948f-fa095f549e3d' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 419

{
  "id" : "867c110b-397e-42aa-948f-fa095f549e3d",
  "issuer" : "https://1d1c5066-f1e4-43cf-9c25-2cb0a6d8bb68.issuer.idp",
  "jwksUri" : "https://1d1c5066-f1e4-43cf-9c25-2cb0a6d8bb68.issuer.idp/jwks",
  "active" : true,
  "createdBy" : "b074b2b2-cd9c-429d-92c9-11d86133b630",
  "createdAt" : {
    "nano" : 970792000,
    "epochSecond" : 1792735484
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Create Oidc Issuer

POST /oidc-issuers

Authorization

This endpoint requires:

  • create action on this oidc-issuer resource.

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://b9333b2c-9a2e-46d2-86cb-4a22017f309c.issuer.idp",
  "jwksUri" : "https://b9333b2c-9a2e-46d2-86cb-4a22017f309c.issuer.idp/jwks",
  "active" : true
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 419

{
  "id" : "fa17c549-fcf0-4941-a2ac-68e7e2b55aca",
  "issuer" : "https://b9333b2c-9a2e-46d2-86cb-4a22017f309c.issuer.idp",
  "jwksUri" : "https://b9333b2c-9a2e-46d2-86cb-4a22017f309c.issuer.idp/jwks",
  "active" : true,
  "createdBy" : "9c645c86-8c77-4cad-895d-f3efd7395650",
  "createdAt" : {
    "nano" : 929187000,
    "epochSecond" : 1792735484
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Update Oidc Issuer

PATCH /oidc-issuers/{id}

Authorization

This endpoint requires:

  • update action on this oidc-issuer resource.

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/2c51b927-0233-4b88-8d05-040c747410c2' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "issuer" : "https://a2776409-5fd0-4d20-87d0-a0620fd741b8.issuer.idp",
  "jwksUri" : "https://a2776409-5fd0-4d20-87d0-a0620fd741b8.issuer.idp/jwks",
  "active" : false
}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420

{
  "id" : "2c51b927-0233-4b88-8d05-040c747410c2",
  "issuer" : "https://a2776409-5fd0-4d20-87d0-a0620fd741b8.issuer.idp",
  "jwksUri" : "https://a2776409-5fd0-4d20-87d0-a0620fd741b8.issuer.idp/jwks",
  "active" : false,
  "createdBy" : "4af73354-27c6-41bf-a9a7-d693b5e3cf03",
  "createdAt" : {
    "nano" : 864762000,
    "epochSecond" : 1792735484
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Delete Oidc Issuer

DELETE /oidc-issuers/{id}

Authorization

This endpoint requires:

  • delete action on this oidc-issuer resource.

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/e5fb3e86-9ed4-4d27-8ad1-a30fe06665fe' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505

{
  "id" : "e5fb3e86-9ed4-4d27-8ad1-a30fe06665fe",
  "issuer" : "https://e158d4eb-4cea-425c-a266-77b8374895d2.issuer.idp",
  "jwksUri" : "https://e158d4eb-4cea-425c-a266-77b8374895d2.issuer.idp/jwks",
  "active" : true,
  "createdBy" : "8771545c-27c3-409e-b871-cab370db2ee3",
  "createdAt" : {
    "nano" : 6641000,
    "epochSecond" : 1792735485
  },
  "deletedAt" : {
    "nano" : 17506000,
    "epochSecond" : 1792735485
  },
  "deletedBy" : "dcdaa1b3-aba7-4be3-acb2-68224fd30aa6",
  "deleted" : true
}

OIDC Public Clients

Find Oidc Public Clients

GET /oidc-public-clients

Authorization

This endpoint requires:

  • read action on this oidc-public-client resource.

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: 2067

[ {
  "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" : 83334000,
    "epochSecond" : 1792735418
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}, {
  "id" : "9f58b076-8c4b-4593-b79a-6ca856080a10",
  "oidcIssuerId" : "25dc604b-b879-4249-90fb-60d0e1b87512",
  "clientId" : "clientId-06ecebaf-265c-4b0a-8972-afca7693ab50",
  "clientSecret" : "clientSecret-8d74e273-b058-49b1-a33e-121c152326c7",
  "authorizationEndpoint" : "https://8e979fb5-cfb2-4786-805b-c4857d6798ea.issuer.idp/authorize",
  "tokenEndpoint" : "https://8e979fb5-cfb2-4786-805b-c4857d6798ea.issuer.idp/token",
  "userInfoEndpoint" : "https://8e979fb5-cfb2-4786-805b-c4857d6798ea.issuer.idp/userinfo",
  "restrictedToOrganizationIds" : [ ],
  "active" : true,
  "createdBy" : "72651172-6dfa-47cc-88ba-981a393bbc97",
  "createdAt" : {
    "nano" : 87960000,
    "epochSecond" : 1792735485
  },
  "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" : 83334000,
    "epochSecond" : 1792735418
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
} ]

Get Oidc Public Client

GET /oidc-public-clients/{id}

Authorization

This endpoint requires:

  • read action on this oidc-public-client resource.

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/a16b6129-d35f-41c7-b64b-e8e926946cd1' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 776

{
  "id" : "a16b6129-d35f-41c7-b64b-e8e926946cd1",
  "oidcIssuerId" : "dc9a8e50-36c8-4ccf-84c2-79cbb9fb4382",
  "clientId" : "clientId-4e0e9341-c2d2-4e02-94b7-87ee4bae9de4",
  "clientSecret" : "clientSecret-52135948-6d2e-450c-90c5-965ee0c898b4",
  "authorizationEndpoint" : "https://a7620499-fa82-4e73-b86a-4f19732e5ca2.issuer.idp/authorize",
  "tokenEndpoint" : "https://a7620499-fa82-4e73-b86a-4f19732e5ca2.issuer.idp/token",
  "userInfoEndpoint" : "https://a7620499-fa82-4e73-b86a-4f19732e5ca2.issuer.idp/userinfo",
  "restrictedToOrganizationIds" : [ ],
  "active" : true,
  "createdBy" : "18cb9827-49e8-4c66-9f8e-3a4591a7a4f5",
  "createdAt" : {
    "nano" : 490031000,
    "epochSecond" : 1792735485
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Create Oidc Public Client

POST /oidc-public-clients

Authorization

This endpoint requires:

  • create action on this oidc-public-client resource.

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" : "16fe2ed0-bd3a-4c08-956a-c77d5f30411f",
  "clientId" : "clientId-4e34138c-4dc4-49ea-99a7-77c20b7f31da",
  "clientSecret" : "clientSecret-811d0ca3-3e4e-4b03-8207-aa5c34e4b7ec",
  "authorizationEndpoint" : "https://2020d62d-9bd6-4a93-98f7-c9d9ce9d0327.issuer.idp/authorize",
  "tokenEndpoint" : "https://2020d62d-9bd6-4a93-98f7-c9d9ce9d0327.issuer.idp/token",
  "userInfoEndpoint" : "https://2020d62d-9bd6-4a93-98f7-c9d9ce9d0327.issuer.idp/userinfo",
  "restrictedToOrganizationIds" : [ ],
  "active" : true
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 776

{
  "id" : "a92a8a19-f8ad-4c2c-8d1f-f8a35dee875f",
  "oidcIssuerId" : "16fe2ed0-bd3a-4c08-956a-c77d5f30411f",
  "clientId" : "clientId-4e34138c-4dc4-49ea-99a7-77c20b7f31da",
  "clientSecret" : "clientSecret-811d0ca3-3e4e-4b03-8207-aa5c34e4b7ec",
  "authorizationEndpoint" : "https://2020d62d-9bd6-4a93-98f7-c9d9ce9d0327.issuer.idp/authorize",
  "tokenEndpoint" : "https://2020d62d-9bd6-4a93-98f7-c9d9ce9d0327.issuer.idp/token",
  "userInfoEndpoint" : "https://2020d62d-9bd6-4a93-98f7-c9d9ce9d0327.issuer.idp/userinfo",
  "restrictedToOrganizationIds" : [ ],
  "active" : true,
  "createdBy" : "8de5766d-d240-47bb-a48d-dbd3cbeb020b",
  "createdAt" : {
    "nano" : 435327000,
    "epochSecond" : 1792735485
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Update Oidc Public Client

PATCH /oidc-public-clients/{id}

Authorization

This endpoint requires:

  • update action on this oidc-public-client resource.

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/7913e7f6-b543-45ff-b422-4cd8eb42d0a2' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "clientId" : "clientId-35b5b869-6672-497c-bc73-e3052381040c",
  "clientSecret" : "clientSecret-cfc50aad-a762-453c-ac03-8d49cd2e9ecb",
  "authorizationEndpoint" : "https://b9a5d996-ce6d-4eee-8bce-b6dbc8ef3991.issuer.idp/authorize",
  "tokenEndpoint" : "https://b9a5d996-ce6d-4eee-8bce-b6dbc8ef3991.issuer.idp/token",
  "userInfoEndpoint" : "https://b9a5d996-ce6d-4eee-8bce-b6dbc8ef3991.issuer.idp/userinfo",
  "restrictedToOrganizationIds" : [ ],
  "active" : false
}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 777

{
  "id" : "7913e7f6-b543-45ff-b422-4cd8eb42d0a2",
  "oidcIssuerId" : "dcb3f286-cba3-4a7b-99b7-68ceb837bdc8",
  "clientId" : "clientId-35b5b869-6672-497c-bc73-e3052381040c",
  "clientSecret" : "clientSecret-cfc50aad-a762-453c-ac03-8d49cd2e9ecb",
  "authorizationEndpoint" : "https://b9a5d996-ce6d-4eee-8bce-b6dbc8ef3991.issuer.idp/authorize",
  "tokenEndpoint" : "https://b9a5d996-ce6d-4eee-8bce-b6dbc8ef3991.issuer.idp/token",
  "userInfoEndpoint" : "https://b9a5d996-ce6d-4eee-8bce-b6dbc8ef3991.issuer.idp/userinfo",
  "restrictedToOrganizationIds" : [ ],
  "active" : false,
  "createdBy" : "3f3ae7c6-500f-45c8-a5c8-b98a7553e308",
  "createdAt" : {
    "nano" : 356442000,
    "epochSecond" : 1792735485
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Delete Oidc Public Client

DELETE /oidc-public-clients/{id}

Authorization

This endpoint requires:

  • delete action on this oidc-public-client resource.

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/bbf6a280-958f-462b-a0eb-d76c1494075d' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 865

{
  "id" : "bbf6a280-958f-462b-a0eb-d76c1494075d",
  "oidcIssuerId" : "a09cea31-14b3-4cb1-a401-a89dcbf0e4b8",
  "clientId" : "clientId-c0c130ff-b25f-407e-869a-b2f346f35ee5",
  "clientSecret" : "clientSecret-73d70165-4dee-42f3-ad62-693f31b8e25c",
  "authorizationEndpoint" : "https://5886148e-33e1-4335-bf62-50afd892bb28.issuer.idp/authorize",
  "tokenEndpoint" : "https://5886148e-33e1-4335-bf62-50afd892bb28.issuer.idp/token",
  "userInfoEndpoint" : "https://5886148e-33e1-4335-bf62-50afd892bb28.issuer.idp/userinfo",
  "restrictedToOrganizationIds" : [ ],
  "active" : true,
  "createdBy" : "b6fa6136-c71a-4079-8ec4-e1a0357479e5",
  "createdAt" : {
    "nano" : 539775000,
    "epochSecond" : 1792735485
  },
  "deletedAt" : {
    "nano" : 556457000,
    "epochSecond" : 1792735485
  },
  "deletedBy" : "ffb24afa-5d34-4efe-9f0e-5d4befa46bb6",
  "deleted" : true
}

Organization to OIDC Public Client Mappings

Find Organization Oidc Public Client Mappings

GET /organization-oidc-public-client-mappings

Authorization

This endpoint requires:

  • read action on this organization-oidc-public-client-mapping resource.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

true

organizationId

String

true

oidcPublicClientId

String

true

name

String

true

active

Boolean

true

customQueryParameters

String

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1620

[ {
  "id" : "35954ff4-541c-4a57-b6b3-d1079d2d12d5",
  "organizationId" : "e25be8a8-3096-4452-8378-9acf73ff63ae",
  "oidcPublicClientId" : "be795bd2-1972-4c4e-a8bd-2a72d769a138",
  "name" : "console-client-a9074d75-f8b1-4a09-b6f1-8e69655dd2d2",
  "active" : true,
  "customQueryParameters" : "{}",
  "createdBy" : "fefe5e05-e652-4c91-996d-af53e75176b6",
  "createdAt" : {
    "nano" : 237546000,
    "epochSecond" : 1792735487
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}, {
  "id" : "78bfc2ff-d2cf-406b-8f55-eaedf3a8d866",
  "organizationId" : "f86122fb-316b-4427-8c38-248165bf4504",
  "oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
  "name" : "NFSUPPORT Google Account",
  "active" : true,
  "customQueryParameters" : "{\"audience\": \"https://gateway.{env}.netfoundry.io/\", \"connection\": \"google-oauth2\"}",
  "createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
  "createdAt" : {
    "nano" : 601123000,
    "epochSecond" : 1792735417
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}, {
  "id" : "a0ab2615-dc57-4b1f-bfc0-60fc73acc56d",
  "organizationId" : "cc2433a9-c951-4a30-a57f-c23567fe7b87",
  "oidcPublicClientId" : "290cc71d-cbd0-4c44-bf9e-a9d33a7314e6",
  "name" : "NFSUPPORT-RO Google Account",
  "active" : true,
  "customQueryParameters" : "{\"audience\": \"https://gateway.{env}.netfoundry.io/\", \"connection\": \"google-oauth2\"}",
  "createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
  "createdAt" : {
    "nano" : 627268000,
    "epochSecond" : 1792735417
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
} ]

Get Organization Oidc Public Client Mapping

GET /organization-oidc-public-client-mappings/{id}

Authorization

This endpoint requires:

  • read action on this organization-oidc-public-client-mapping resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

oidcPublicClientId

String

true

name

String

true

active

Boolean

true

customQueryParameters

String

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/273518b4-b8c8-4449-a62e-03f57f58d582' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 495

{
  "id" : "273518b4-b8c8-4449-a62e-03f57f58d582",
  "organizationId" : "3dbbb1f1-dab9-4232-ae4c-3cf453fcf2d0",
  "oidcPublicClientId" : "337e6901-a4f3-4a49-b0b1-e0dda22bda2a",
  "name" : "console-client-78c59895-5673-4dad-a07f-10dd9b1d7ef5",
  "active" : true,
  "customQueryParameters" : "{}",
  "createdBy" : "548ea682-b3b0-46d4-a6c3-0b0966b6f836",
  "createdAt" : {
    "nano" : 669838000,
    "epochSecond" : 1792735487
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Create Organization Oidc Public Client Mapping

POST /organization-oidc-public-client-mappings

Authorization

This endpoint requires:

  • create action on this organization-oidc-public-client-mapping resource.

  • read action on the oidc-public-client resource identified by the oidcPublicClientId property.

Request fields

Path Type Optional Description

organizationId

String

true

oidcPublicClientId

String

true

name

String

true

active

Boolean

true

customQueryParameters

String

true

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

oidcPublicClientId

String

true

name

String

true

active

Boolean

true

customQueryParameters

String

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "organizationId" : "061a6be0-cf2c-4f86-8d8f-e9f273679bac",
  "oidcPublicClientId" : "11e8de0a-6562-486e-85c6-edb508a28ff9",
  "name" : "console-client-7d14dd3b-dc56-410c-95fc-5b0d24c60daa",
  "active" : true,
  "customQueryParameters" : "{}"
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 495

{
  "id" : "2c99611a-b8c5-4bf3-a224-9f614eb6490a",
  "organizationId" : "061a6be0-cf2c-4f86-8d8f-e9f273679bac",
  "oidcPublicClientId" : "11e8de0a-6562-486e-85c6-edb508a28ff9",
  "name" : "console-client-7d14dd3b-dc56-410c-95fc-5b0d24c60daa",
  "active" : true,
  "customQueryParameters" : "{}",
  "createdBy" : "66fcdf10-1a4e-4da8-8d06-a6f26fa8d55d",
  "createdAt" : {
    "nano" : 612703000,
    "epochSecond" : 1792735487
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Update Organization Oidc Public Client Mapping

PATCH /organization-oidc-public-client-mappings/{id}

Authorization

This endpoint requires:

  • update action on this organization-oidc-public-client-mapping resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Request fields

Path Type Optional Description

name

String

true

active

Boolean

true

customQueryParameters

String

true

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

oidcPublicClientId

String

true

name

String

true

active

Boolean

true

customQueryParameters

String

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/1edb2027-1e35-4d5d-b343-221df70ce04a' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "custom-client-dd2856c1-6f8f-44d1-b078-12512dcde460",
  "active" : true,
  "customQueryParameters" : "{}"
}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 494

{
  "id" : "1edb2027-1e35-4d5d-b343-221df70ce04a",
  "organizationId" : "04f7d992-ad93-466d-a806-eefa57bc2193",
  "oidcPublicClientId" : "10d70659-e597-462a-94c0-036d2f71c42f",
  "name" : "custom-client-dd2856c1-6f8f-44d1-b078-12512dcde460",
  "active" : true,
  "customQueryParameters" : "{}",
  "createdBy" : "4a49ee8f-378c-433b-ba70-fdc8cbeb15ce",
  "createdAt" : {
    "nano" : 528927000,
    "epochSecond" : 1792735487
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Delete Organization Oidc Public Client Mapping

DELETE /organization-oidc-public-client-mappings/{id}

Authorization

This endpoint requires:

  • delete action on this organization-oidc-public-client-mapping resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

oidcPublicClientId

String

true

name

String

true

active

Boolean

true

customQueryParameters

String

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/organization-oidc-public-client-mappings/bb95a3ec-d359-4280-8f68-f4abc768fd1f' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 543

{
  "id" : "bb95a3ec-d359-4280-8f68-f4abc768fd1f",
  "organizationId" : "f1246ae8-8e96-44e9-a6fb-5ee4582ff0f5",
  "oidcPublicClientId" : "5abc78e2-8c3b-43e9-b06f-dff99ed5dcf5",
  "name" : "number two",
  "active" : true,
  "customQueryParameters" : "{}",
  "createdBy" : "363a0297-f0cf-45de-bbe8-5915f00e7cd5",
  "createdAt" : {
    "nano" : 718408000,
    "epochSecond" : 1792735487
  },
  "deletedAt" : {
    "nano" : 728890000,
    "epochSecond" : 1792735487
  },
  "deletedBy" : "b10f3d86-de6f-4ec1-ac89-4c8c648704eb",
  "deleted" : true
}

OIDC Audiences

Find Oidc Audiences

GET /oidc-audiences

Authorization

This endpoint requires:

  • read action on this oidc-audience resource.

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: 1280

[ {
  "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" : 90913000,
    "epochSecond" : 1792735418
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}, {
  "id" : "8110908f-6876-4fb0-bf94-acb4e1ccadd4",
  "oidcIssuerId" : "b251dccc-d881-4e36-93d8-ddf53462c6bb",
  "audience" : "mop-aud-7e10cc39-4e4d-4ede-ac1c-26a0c81a3319",
  "restrictedToOrganizationIds" : [ ],
  "active" : true,
  "createdBy" : "375163f2-d4c9-483f-96df-b2ad098299c9",
  "createdAt" : {
    "nano" : 170912000,
    "epochSecond" : 1792735484
  },
  "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" : 90913000,
    "epochSecond" : 1792735418
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
} ]

Get Oidc Audience

GET /oidc-audiences/{id}

Authorization

This endpoint requires:

  • read action on this oidc-audience resource.

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/10d1032a-5a13-4771-a2a3-9e6ed08d0fb9' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430

{
  "id" : "10d1032a-5a13-4771-a2a3-9e6ed08d0fb9",
  "oidcIssuerId" : "12df3744-cc37-4158-a039-a026367b7274",
  "audience" : "mop-aud-e72ade3d-8a0f-4620-90c1-8fc2019b8171",
  "restrictedToOrganizationIds" : [ ],
  "active" : true,
  "createdBy" : "91558804-057c-4ce7-bdec-7006873fa80a",
  "createdAt" : {
    "nano" : 516020000,
    "epochSecond" : 1792735484
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Create Oidc Audience

POST /oidc-audiences

Authorization

This endpoint requires:

  • create action on this oidc-audience resource.

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" : "fc009da2-89ae-40ee-b277-ed06e99f31cb",
  "audience" : "mop-aud-ef503bc9-7cec-4b41-93af-483734c0e276",
  "restrictedToOrganizationIds" : [ ],
  "active" : true
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430

{
  "id" : "cee6cbf7-445a-483d-854d-8750f75c7298",
  "oidcIssuerId" : "fc009da2-89ae-40ee-b277-ed06e99f31cb",
  "audience" : "mop-aud-ef503bc9-7cec-4b41-93af-483734c0e276",
  "restrictedToOrganizationIds" : [ ],
  "active" : true,
  "createdBy" : "1c223610-a3c8-4360-9588-ebf3d6dded13",
  "createdAt" : {
    "nano" : 479618000,
    "epochSecond" : 1792735484
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Update Oidc Audience

PATCH /oidc-audiences/{id}

Authorization

This endpoint requires:

  • update action on this oidc-audience resource.

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/ce1f59e9-64d5-4893-a524-89c2ed52310d' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "audience" : "mop-aud-ae2203e8-ff16-41b6-b9a8-b72cfa635b8d",
  "restrictedToOrganizationIds" : [ ],
  "active" : false
}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 431

{
  "id" : "ce1f59e9-64d5-4893-a524-89c2ed52310d",
  "oidcIssuerId" : "8dde7284-98fb-4d7c-9bf1-04daed2a4d21",
  "audience" : "mop-aud-ae2203e8-ff16-41b6-b9a8-b72cfa635b8d",
  "restrictedToOrganizationIds" : [ ],
  "active" : false,
  "createdBy" : "cb031ac2-c77b-41a8-847a-4524138f9d69",
  "createdAt" : {
    "nano" : 392718000,
    "epochSecond" : 1792735484
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Delete Oidc Audience

DELETE /oidc-audiences/{id}

Authorization

This endpoint requires:

  • delete action on this oidc-audience resource.

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/11409a24-1f4e-411f-ac9f-0e06b8e03aaf' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 519

{
  "id" : "11409a24-1f4e-411f-ac9f-0e06b8e03aaf",
  "oidcIssuerId" : "a6bb8658-9a29-4f38-ba8b-e5d04862e0a8",
  "audience" : "mop-aud-02e6d04d-057a-40d8-ae84-f438f394cfb4",
  "restrictedToOrganizationIds" : [ ],
  "active" : true,
  "createdBy" : "9a40d220-f6e5-4170-8d43-2156e9b05650",
  "createdAt" : {
    "nano" : 560398000,
    "epochSecond" : 1792735484
  },
  "deletedAt" : {
    "nano" : 570266000,
    "epochSecond" : 1792735484
  },
  "deletedBy" : "4ef71bc0-de27-40f6-8d2a-b9dc39fd685d",
  "deleted" : true
}

User Identity to OIDC Audience Mappings

Find User Identity Audience Mappings

GET /user-identity-oidc-audience-mappings

Authorization

This endpoint requires:

  • read action on this user-identity-oidc-audience-mapping resource.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

true

userIdentityId

String

true

oidcAudienceId

String

true

subject

String

true

active

Boolean

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3

[ ]

Get User Identity Audience Mapping

GET /user-identity-oidc-audience-mappings/{id}

Authorization

This endpoint requires:

  • read action on this user-identity-oidc-audience-mapping resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Response fields

Path Type Optional Description

id

String

true

userIdentityId

String

true

oidcAudienceId

String

true

subject

String

true

active

Boolean

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/82827966-23ae-4e12-ab3c-48b070980575' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 460

{
  "id" : "82827966-23ae-4e12-ab3c-48b070980575",
  "userIdentityId" : "a8c29e33-92b8-4422-be23-79767c8f041f",
  "oidcAudienceId" : "99ab2f02-63b4-4105-a9c6-ee8e5ed3ec61",
  "subject" : "console-client-8c084ed6-0d55-425d-aa05-e269f4fdde8d",
  "active" : true,
  "createdBy" : "187f295d-05ac-4590-92e1-b577a70db442",
  "createdAt" : {
    "nano" : 461836000,
    "epochSecond" : 1792735491
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Create User Identity Audience Mapping

POST /user-identity-oidc-audience-mappings

Authorization

This endpoint requires:

  • create action on this user-identity-oidc-audience-mapping resource.

  • create-identity-mapping action on the user-identity resource identified by the userIdentityId property.

  • read action on the oidc-audience resource identified by the oidcAudienceId property.

Request fields

Path Type Optional Description

userIdentityId

String

true

oidcAudienceId

String

true

subject

String

true

active

Boolean

true

Response fields

Path Type Optional Description

id

String

true

userIdentityId

String

true

oidcAudienceId

String

true

subject

String

true

active

Boolean

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "userIdentityId" : "3916fa89-91c8-40ff-b34c-d48a0c159be6",
  "oidcAudienceId" : "f39f3922-5add-4c1a-a2ae-07231f0b392b",
  "subject" : "console-client-93141ca4-618f-48b6-a90e-f9cf3a61360a",
  "active" : true
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 460

{
  "id" : "122969ef-fc22-43e9-adde-95b9cdf11a20",
  "userIdentityId" : "3916fa89-91c8-40ff-b34c-d48a0c159be6",
  "oidcAudienceId" : "f39f3922-5add-4c1a-a2ae-07231f0b392b",
  "subject" : "console-client-93141ca4-618f-48b6-a90e-f9cf3a61360a",
  "active" : true,
  "createdBy" : "a35f693a-9562-45d3-acb2-888d6fbf7056",
  "createdAt" : {
    "nano" : 417393000,
    "epochSecond" : 1792735491
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Update User Identity Audience Mapping

PATCH /user-identity-oidc-audience-mappings/{id}

Authorization

This endpoint requires:

  • update action on this user-identity-oidc-audience-mapping resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Request fields

Path Type Optional Description

active

Boolean

true

Response fields

Path Type Optional Description

id

String

true

userIdentityId

String

true

oidcAudienceId

String

true

subject

String

true

active

Boolean

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/43f3d8b1-6157-400c-9888-70cb62adab05' -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" : "43f3d8b1-6157-400c-9888-70cb62adab05",
  "userIdentityId" : "86dacd20-7927-4e98-b7ac-e54c0b22ab6d",
  "oidcAudienceId" : "7b51ed2b-931b-47d6-b85c-ff76f14e7bc1",
  "subject" : "console-client-43c871c7-4885-45f4-8e70-522279fdc15a",
  "active" : false,
  "createdBy" : "dc41d33c-2bae-46a0-87d0-57858f662f95",
  "createdAt" : {
    "nano" : 332099000,
    "epochSecond" : 1792735491
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Delete User Identity Audience Mapping

DELETE /user-identity-oidc-audience-mappings/{id}

Authorization

This endpoint requires:

  • delete action on this user-identity-oidc-audience-mapping resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Response fields

Path Type Optional Description

id

String

true

userIdentityId

String

true

oidcAudienceId

String

true

subject

String

true

active

Boolean

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/user-identity-oidc-audience-mappings/ffbe24e5-24ee-4e19-82aa-58fe1c3ff519' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 549

{
  "id" : "ffbe24e5-24ee-4e19-82aa-58fe1c3ff519",
  "userIdentityId" : "89d61c9d-480a-45c2-8961-dc3343643ad9",
  "oidcAudienceId" : "e76f82d4-f9b0-4e45-894b-7155d75775d5",
  "subject" : "console-client-c029d382-7231-438e-9f19-8052ca63959f",
  "active" : true,
  "createdBy" : "1c20e3f5-f1cd-4490-aa93-4534b0fed126",
  "createdAt" : {
    "nano" : 508020000,
    "epochSecond" : 1792735491
  },
  "deletedAt" : {
    "nano" : 523922000,
    "epochSecond" : 1792735491
  },
  "deletedBy" : "7dbaef66-b7af-4bdc-b348-8859d5ac4768",
  "deleted" : true
}

Identity Providers

Find Identity Providers

GET /identity-providers

Authorization

This endpoint requires:

  • read action on this identity-provider resource.

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: 1155

[ {
  "id" : "1184458a-7479-4080-9fd7-63f502919ace",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ConnectionId" : "auth0-opaque-connectionId-4",
  "name" : "Google-Account",
  "auth0ConnectionType" : "Social",
  "active" : true,
  "createdAt" : {
    "nano" : 965823000,
    "epochSecond" : 1792735421
  },
  "updatedAt" : null,
  "deletedAt" : null
}, {
  "id" : "1386fc52-1786-4ea3-8056-f340502a2334",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ConnectionId" : "auth0-opaque-connectionId-3",
  "name" : "ACME Federated Active Directory",
  "auth0ConnectionType" : "Enterprise",
  "active" : true,
  "createdAt" : {
    "nano" : 957616000,
    "epochSecond" : 1792735421
  },
  "updatedAt" : null,
  "deletedAt" : null
}, {
  "id" : "18cf6310-9478-4173-bcf1-d1113ce2d674",
  "organizationId" : "c5cafc95-1913-43d1-9a7b-ca1f8e075e2e",
  "auth0ConnectionId" : "auth0-opaque-connectionId-272",
  "name" : "Username/Password",
  "auth0ConnectionType" : "Database",
  "active" : true,
  "createdAt" : {
    "nano" : 653350000,
    "epochSecond" : 1792735477
  },
  "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}}

Authorization

This endpoint requires:

  • read action on this identity-provider resource.

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/1386fc52-1786-4ea3-8056-f340502a2334' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 394

{
  "id" : "1386fc52-1786-4ea3-8056-f340502a2334",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ConnectionId" : "auth0-opaque-connectionId-3",
  "name" : "ACME Federated Active Directory",
  "auth0ConnectionType" : "Enterprise",
  "active" : true,
  "createdAt" : {
    "nano" : 957616000,
    "epochSecond" : 1792735421
  },
  "updatedAt" : null,
  "deletedAt" : null
}

Create Identity Provider

POST /identity-providers

Authorization

This endpoint requires:

  • create action on this identity-provider resource.

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" : "d3a51b06-aafa-41fd-81b1-c17111e4050d",
  "auth0ConnectionId" : "auth0-opaque-connection",
  "name" : "Corp SAML",
  "auth0ConnectionType" : "Enterprise"
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 368

{
  "id" : "33656773-4988-4328-82e0-f95f8334d576",
  "organizationId" : "d3a51b06-aafa-41fd-81b1-c17111e4050d",
  "auth0ConnectionId" : "auth0-opaque-connection",
  "name" : "Corp SAML",
  "auth0ConnectionType" : "Enterprise",
  "active" : true,
  "createdAt" : {
    "nano" : 549598000,
    "epochSecond" : 1792735477
  },
  "updatedAt" : null,
  "deletedAt" : null
}

Update Identity Provider

PUT /identity-providers/{id}

Authorization

This endpoint requires:

  • update action on this identity-provider resource.

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/1894403c-afd7-4dc1-9713-f05db45955c1' -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" : "1894403c-afd7-4dc1-9713-f05db45955c1",
  "organizationId" : "74e570b7-2746-4748-9c0d-55d4f9a40e8a",
  "auth0ConnectionId" : "auth0-opaque-connectionId-278",
  "name" : "New IdP Name",
  "auth0ConnectionType" : "Database",
  "active" : true,
  "createdAt" : {
    "nano" : 876028000,
    "epochSecond" : 1792735477
  },
  "updatedAt" : {
    "nano" : 897628000,
    "epochSecond" : 1792735477
  },
  "deletedAt" : null
}

Activate Or Deactivate Identity Provider

PUT /identity-providers/{id}/{action:activate|deactivate}

Authorization

This endpoint requires:

  • update action on this identity-provider resource.

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/18cf6310-9478-4173-bcf1-d1113ce2d674/activate' -i -X PUT

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380

{
  "id" : "18cf6310-9478-4173-bcf1-d1113ce2d674",
  "organizationId" : "c5cafc95-1913-43d1-9a7b-ca1f8e075e2e",
  "auth0ConnectionId" : "auth0-opaque-connectionId-272",
  "name" : "Username/Password",
  "auth0ConnectionType" : "Database",
  "active" : true,
  "createdAt" : {
    "nano" : 653350000,
    "epochSecond" : 1792735477
  },
  "updatedAt" : null,
  "deletedAt" : null
}

Delete Identity Provider

DELETE /identity-providers/{id}

Authorization

This endpoint requires:

  • delete action on this identity-provider resource.

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/d40ac3a0-5707-49ec-a4ea-31066897a9f0' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492

{
  "id" : "d40ac3a0-5707-49ec-a4ea-31066897a9f0",
  "organizationId" : "84e61ba9-7ea4-442d-8b7d-56662bd2c59e",
  "auth0ConnectionId" : "auth0-opaque-connectionId-276",
  "name" : "Username/Password",
  "auth0ConnectionType" : "Database",
  "active" : true,
  "createdAt" : {
    "nano" : 806868000,
    "epochSecond" : 1792735477
  },
  "updatedAt" : {
    "nano" : 829044000,
    "epochSecond" : 1792735477
  },
  "deletedAt" : {
    "nano" : 828000000,
    "epochSecond" : 1792735477
  }
}

Default Roles

Find Default Roles

GET /default-roles

Authorization

This endpoint requires:

  • read action on this default-role resource.

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: 1388

[ {
  "id" : "1e9cc431-99c8-41d6-a9ae-e27af44087b7",
  "organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
  "name" : "Network Group Admin - Cloud Engineering Network Group",
  "roleType" : "Standard",
  "roleId" : "b75be358-a3f9-40a5-972d-a804c4758041",
  "createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
  "createdAt" : {
    "nano" : 975722000,
    "epochSecond" : 1792735471
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}, {
  "id" : "3804ec48-b694-474e-a045-7998c17d1a03",
  "organizationId" : "95068bb0-864b-4930-b06e-9acf4957c826",
  "name" : "Standard Role Admin - Network Group Admin - Cloud Engineering",
  "roleType" : "Standard",
  "roleId" : "2854b8f9-6538-11ea-98de-128b2daaf7e4",
  "createdBy" : "2b6f496d-36f1-4e66-a205-8abcf1d41d74",
  "createdAt" : {
    "nano" : 975722000,
    "epochSecond" : 1792735471
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}, {
  "id" : "3c11557b-9d03-4a7a-a42d-d6bde35ee038",
  "organizationId" : "232e009d-cc89-4c1e-a342-ab2b89b25fcd",
  "name" : "Custom Role - 922c3d65-eec0-4ff8-9257-1de42ba2d64f",
  "roleType" : "Custom",
  "roleId" : "922c3d65-eec0-4ff8-9257-1de42ba2d64f",
  "createdBy" : "9e171f0b-59ca-4645-92d6-9de43a7d6255",
  "createdAt" : {
    "nano" : 187651000,
    "epochSecond" : 1792735473
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
} ]

Get Default Role

GET /default-roles/{id}

Authorization

This endpoint requires:

  • read action on this default-role resource.

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/cf553b34-cc7e-4beb-b6fc-16f2ad4a39f2' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 454

{
  "id" : "cf553b34-cc7e-4beb-b6fc-16f2ad4a39f2",
  "organizationId" : "1bc39909-7339-4b9d-91c8-7643744452a7",
  "name" : "Custom Role - 2d1f2771-cd66-4a0b-b07d-32dca2204309",
  "roleType" : "Custom",
  "roleId" : "2d1f2771-cd66-4a0b-b07d-32dca2204309",
  "createdBy" : "297af690-d2e7-4851-a163-51e87efcc07b",
  "createdAt" : {
    "nano" : 816601000,
    "epochSecond" : 1792735472
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Create Default Role

POST /default-roles

Authorization

This endpoint requires:

  • create action on this default-role resource.

  • update action on the organization resource identified by the organization property.

Request fields

Path Type Optional Description

organizationId

String

true

roleType

String

true

Must be one of [Standard, Custom].

roleId

String

true

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

name

String

true

roleType

String

true

Must be one of [Standard, Custom].

roleId

String

true

createdBy

String

true

createdAt

Object

true

deletedAt

Object

true

deletedBy

String

true

deleted

Boolean

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "organizationId" : "ddf3deb0-ae39-42b9-9d67-57e81077461a",
  "roleType" : "Standard",
  "roleId" : "c865adc4-9560-45f3-9f65-57f9c26ff2d6"
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 458

{
  "id" : "07cbf390-ac1c-4fed-bf0d-94e29add6111",
  "organizationId" : "ddf3deb0-ae39-42b9-9d67-57e81077461a",
  "name" : "Standard Role - c865adc4-9560-45f3-9f65-57f9c26ff2d6",
  "roleType" : "Standard",
  "roleId" : "c865adc4-9560-45f3-9f65-57f9c26ff2d6",
  "createdBy" : "de59dbb4-8925-445c-a6ed-de66c36f761d",
  "createdAt" : {
    "nano" : 806800000,
    "epochSecond" : 1792735473
  },
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Delete Default Role

DELETE /default-roles/{id}

Authorization

This endpoint requires:

  • delete action on this default-role resource.

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/3ca02fbf-ef9a-4480-aad0-333b3f2601c5' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 547

{
  "id" : "3ca02fbf-ef9a-4480-aad0-333b3f2601c5",
  "organizationId" : "1bc39909-7339-4b9d-91c8-7643744452a7",
  "name" : "Standard Role - 32ab4693-e3fe-40ac-a251-7b5dca0ac781",
  "roleType" : "Standard",
  "roleId" : "32ab4693-e3fe-40ac-a251-7b5dca0ac781",
  "createdBy" : "c660fef7-27dc-4362-a0f8-7f19560f27fb",
  "createdAt" : {
    "nano" : 616585000,
    "epochSecond" : 1792735473
  },
  "deletedAt" : {
    "nano" : 625000000,
    "epochSecond" : 1792735473
  },
  "deletedBy" : "a00da940-ae85-4d4e-958c-71b86cfc64f9",
  "deleted" : true
}

Grant Default Role

POST /default-roles/{id}/grant

Authorization

This endpoint requires:

  • read action on this default-role resource.

  • create action on the invitation resource identified by the organization property.

Path parameters

Parameter Type Optional Description

id

Object

false

Request fields

No request body.

Response fields

No response body.

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/default-roles/f8837fbf-43be-4127-8b24-1080c67ca35f/grant' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "includeIdentityIds" : [ "f76c313f-f118-44e4-b744-875bb36ded6d", "7d5146bb-533e-4972-a1be-64fceb4aa859", "4e18f093-a3b9-47c0-82ab-ef66f5a571f5" ],
  "excludeIdentityIds" : [ "d5aab5eb-7c73-4fca-920a-45a616d45c39", "7d5146bb-533e-4972-a1be-64fceb4aa859", "4e18f093-a3b9-47c0-82ab-ef66f5a571f5" ]
}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51

{
  "f76c313f-f118-44e4-b744-875bb36ded6d" : 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

email

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" : "3bedde37-a94e-4cd6-8e58-782f29b39434",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "First",
  "lastName" : "Last",
  "email" : "random-456@acme.com",
  "identityMappings" : [ {
    "id" : "e5ffdd8e-0bdb-4d39-807b-9df4bf8dce80",
    "auth0UserId" : "auth0-opaque-userId-457",
    "identityProviderId" : "33376b4e-6976-4df0-9ba2-219eeeee3517",
    "userIdentityId" : "3bedde37-a94e-4cd6-8e58-782f29b39434"
  } ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 795136000,
    "epochSecond" : 1792735489
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : { },
  "name" : "First Last",
  "status" : "ACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}

Get Identity

GET /identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

Authorization

This endpoint requires:

  • read action on this user-identity resource.

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

email

String

true

tenantId

String

true

Deprecated..

createdAt

Object

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/identities/c0a4751d-1247-4c75-b2c8-093602b59f70' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 772

{
  "id" : "c0a4751d-1247-4c75-b2c8-093602b59f70",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "John",
  "lastName" : "Doe",
  "email" : "john.doe@acme.com",
  "identityMappings" : [ {
    "id" : "5a4e4c06-c2d4-4448-adaa-bb42a0452818",
    "auth0UserId" : "auth0-opaque-userId-325",
    "identityProviderId" : "b07d1d0e-914d-41d2-a85c-1e4e7133da0b",
    "userIdentityId" : "c0a4751d-1247-4c75-b2c8-093602b59f70"
  } ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 606610000,
    "epochSecond" : 1792735482
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : { },
  "name" : "John Doe",
  "status" : "ACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}

Find User Identities

GET /user-identities

Authorization

This endpoint requires:

  • read action on this user-identity resource.

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

email

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: 2177

[ {
  "id" : "0b82e071-4c13-4a93-bd1f-2f47e94dd160",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "First",
  "lastName" : "Last",
  "email" : "random-344@acme.com",
  "identityMappings" : [ {
    "id" : "2aac2060-fc61-4ce5-82c6-4379ec1890fb",
    "auth0UserId" : "auth0-opaque-userId-345",
    "identityProviderId" : "33376b4e-6976-4df0-9ba2-219eeeee3517",
    "userIdentityId" : "0b82e071-4c13-4a93-bd1f-2f47e94dd160"
  } ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 523816000,
    "epochSecond" : 1792735483
  },
  "deletedAt" : null,
  "invited" : true,
  "tags" : { },
  "name" : "First Last",
  "status" : "PENDING",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}, {
  "id" : "12feb15d-73c4-42be-9833-239a3e08fc0b",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "Scalar",
  "lastName" : "Tag",
  "email" : "scalar.tag.-461@acme.com",
  "identityMappings" : [ ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 940397000,
    "epochSecond" : 1792735489
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : {
    "env" : [ "staging", "prod" ],
    "team" : [ "sre" ]
  },
  "name" : "Scalar Tag",
  "status" : "ACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}, {
  "id" : "1bcd8bc9-eb8e-4972-bcf7-82fd096d321a",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "Bobby",
  "lastName" : "White",
  "email" : "bobby.white@acme.com",
  "identityMappings" : [ {
    "id" : "ad3c5c6e-0934-4d3f-8b0e-f6d1c0231f2f",
    "auth0UserId" : "auth0-opaque-userId-453",
    "identityProviderId" : "33376b4e-6976-4df0-9ba2-219eeeee3517",
    "userIdentityId" : "1bcd8bc9-eb8e-4972-bcf7-82fd096d321a"
  } ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 636088000,
    "epochSecond" : 1792735489
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : { },
  "name" : "Bobby White",
  "status" : "ACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
} ]

Get User Identity

GET /user-identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

Authorization

This endpoint requires:

  • read action on this user-identity resource.

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

email

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/c0a4751d-1247-4c75-b2c8-093602b59f70' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 772

{
  "id" : "c0a4751d-1247-4c75-b2c8-093602b59f70",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "John",
  "lastName" : "Doe",
  "email" : "john.doe@acme.com",
  "identityMappings" : [ {
    "id" : "5a4e4c06-c2d4-4448-adaa-bb42a0452818",
    "auth0UserId" : "auth0-opaque-userId-325",
    "identityProviderId" : "b07d1d0e-914d-41d2-a85c-1e4e7133da0b",
    "userIdentityId" : "c0a4751d-1247-4c75-b2c8-093602b59f70"
  } ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 606610000,
    "epochSecond" : 1792735482
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : { },
  "name" : "John Doe",
  "status" : "ACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}

Get User Identity By Mapping

GET /user-identities/mapping/{auth0UserId}/{identityProviderId}

Authorization

This endpoint requires:

  • read action on this user-identity resource.

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

email

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-325/b07d1d0e-914d-41d2-a85c-1e4e7133da0b' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 772

{
  "id" : "c0a4751d-1247-4c75-b2c8-093602b59f70",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "John",
  "lastName" : "Doe",
  "email" : "john.doe@acme.com",
  "identityMappings" : [ {
    "id" : "5a4e4c06-c2d4-4448-adaa-bb42a0452818",
    "auth0UserId" : "auth0-opaque-userId-325",
    "identityProviderId" : "b07d1d0e-914d-41d2-a85c-1e4e7133da0b",
    "userIdentityId" : "c0a4751d-1247-4c75-b2c8-093602b59f70"
  } ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 606610000,
    "epochSecond" : 1792735482
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : { },
  "name" : "John Doe",
  "status" : "ACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}

Create Identity

POST /user-identities

Authorization

This endpoint requires:

  • create action on this user-identity resource.

Request fields

Path Type Optional Description

organizationId

String

true

firstName

String

true

lastName

String

true

email

String

true

tags

Map

true

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

firstName

String

true

lastName

String

true

email

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" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "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" : "c9cb435c-75d8-47ce-9f15-4c8aba241262",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "Jane",
  "lastName" : "Doe",
  "email" : "jane.doe@acme.com",
  "identityMappings" : [ ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 713812000,
    "epochSecond" : 1792735490
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : { },
  "name" : "Jane Doe",
  "status" : "ACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}

Update

PUT /user-identities/{id}

Authorization

This endpoint requires:

  • update action on this user-identity resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Request fields

Path Type Optional Description

firstName

String

true

lastName

String

true

email

String

true

tags

Map

true

Response fields

Path Type Optional Description

id

String

true

organizationId

String

true

firstName

String

true

lastName

String

true

email

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/ad37a398-568b-4dcb-ab49-332c041ab27b' -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" : "ad37a398-568b-4dcb-ab49-332c041ab27b",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "Bobby",
  "lastName" : "White",
  "email" : "bobby.white@acme.com",
  "identityMappings" : [ {
    "id" : "f567efae-13ca-4d79-a053-afcb499792a1",
    "auth0UserId" : "auth0-opaque-userId-469",
    "identityProviderId" : "33376b4e-6976-4df0-9ba2-219eeeee3517",
    "userIdentityId" : "ad37a398-568b-4dcb-ab49-332c041ab27b"
  } ],
  "identityAudienceMappings" : [ ],
  "active" : true,
  "createdAt" : {
    "nano" : 226693000,
    "epochSecond" : 1792735490
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : { },
  "name" : "Bobby White",
  "status" : "ACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}

Activate Or Deactivate User Identity

PUT /user-identities/{id}/{action:activate|deactivate}

Authorization

This endpoint requires:

  • update-active action on this user-identity resource.

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

email

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/801e7215-f8d2-497a-944a-c22b7b8a562f/deactivate' -i -X PUT

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 781

{
  "id" : "801e7215-f8d2-497a-944a-c22b7b8a562f",
  "organizationId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "firstName" : "First",
  "lastName" : "Last",
  "email" : "random-472@acme.com",
  "identityMappings" : [ {
    "id" : "478d1df8-63fd-4175-bdb7-743c84739dc8",
    "auth0UserId" : "auth0-opaque-userId-473",
    "identityProviderId" : "33376b4e-6976-4df0-9ba2-219eeeee3517",
    "userIdentityId" : "801e7215-f8d2-497a-944a-c22b7b8a562f"
  } ],
  "identityAudienceMappings" : [ ],
  "active" : false,
  "createdAt" : {
    "nano" : 350495000,
    "epochSecond" : 1792735490
  },
  "deletedAt" : null,
  "invited" : false,
  "tags" : { },
  "name" : "First Last",
  "status" : "INACTIVE",
  "tenantId" : "60be28e4-d9c7-4b28-b70a-d8819875f38b",
  "type" : "UserIdentity"
}

Reset User Identity Mfa Settings

PUT /user-identities/{id}/reset-mfa

Authorization

This endpoint requires:

  • update-reset-mfa action on this user-identity resource.

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/dedae0d3-71de-4875-91fb-f695f83b645b/reset-mfa' -i -X PUT

Example response

HTTP/1.1 200 OK

Delete User Identity Passkeys

DELETE /user-identities/{id}/passkeys

Authorization

This endpoint requires:

  • update-reset-mfa action on this user-identity resource.

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/928efc4a-ac90-4824-ab01-b32e4873853c/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-mapping action on this user-identity resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Request fields

Path Type Optional Description

auth0UserId

String

true

identityProviderId

String

true

Response fields

No response body.

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/user-identities/f0eaa462-6a8a-4879-bca0-b35006d3c085/mapping' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "auth0UserId" : "new-auth0-userId:f5576d6b-aae7-42f3-a27d-12f51a3a1f47",
  "identityProviderId" : "b07d1d0e-914d-41d2-a85c-1e4e7133da0b"
}'

Example response

HTTP/1.1 200 OK

API Account Identity

Find Api Account Identities

GET /api-account-identities

Authorization

This endpoint requires:

  • read action on this api-account-identity resource.

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

email

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: 2224

[ {
  "id" : "072359aa-5eb1-4e8c-80f9-9e2516b90166",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ClientId" : null,
  "awsCognitoClientId" : "d3c06241-cddc-4290-9ff9-ce2fda0224cf|egguwgft",
  "authenticationUrl" : "https://netfoundry-test-ewxhpm.auth.us-east-1.amazoncognito.com/oauth2/token",
  "name" : "Test Rotation",
  "contactEmail" : "hr.director@acme.com",
  "description" : "description goes here",
  "active" : true,
  "createdAt" : {
    "nano" : 175254000,
    "epochSecond" : 1792735427
  },
  "updatedAt" : {
    "nano" : 200466000,
    "epochSecond" : 1792735427
  },
  "deletedAt" : null,
  "tags" : { },
  "email" : "hr.director@acme.com",
  "tenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "type" : "ApiAccountIdentity"
}, {
  "id" : "27d4de27-a741-4462-b506-118d4ab8d737",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ClientId" : "6633c405-23c3-44eb-83d0-015d1080aa04",
  "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" : 143452000,
    "epochSecond" : 1792735422
  },
  "updatedAt" : {
    "nano" : 467065000,
    "epochSecond" : 1792735426
  },
  "deletedAt" : null,
  "tags" : { },
  "email" : "no-reply@acme.com",
  "tenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "type" : "ApiAccountIdentity"
}, {
  "id" : "2ab52755-efd2-40e4-85ee-22b74a615d52",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ClientId" : null,
  "awsCognitoClientId" : "d3c06241-cddc-4290-9ff9-ce2fda0224cf|puncbhkv",
  "authenticationUrl" : "https://netfoundry-test-ewxhpm.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" : 529288000,
    "epochSecond" : 1792735428
  },
  "updatedAt" : null,
  "deletedAt" : null,
  "tags" : { },
  "email" : "hr.director@acme.com",
  "tenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "type" : "ApiAccountIdentity"
} ]

Get Api Account Identity

GET /api-account-identities/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

Authorization

This endpoint requires:

  • read action on this api-account-identity resource.

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

email

String

true

tenantId

String

true

Deprecated..

type

String

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/27d4de27-a741-4462-b506-118d4ab8d737' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 734

{
  "id" : "27d4de27-a741-4462-b506-118d4ab8d737",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ClientId" : "6633c405-23c3-44eb-83d0-015d1080aa04",
  "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" : 143452000,
    "epochSecond" : 1792735422
  },
  "updatedAt" : {
    "nano" : 467065000,
    "epochSecond" : 1792735426
  },
  "deletedAt" : null,
  "tags" : { },
  "email" : "no-reply@acme.com",
  "tenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "type" : "ApiAccountIdentity"
}

Get Api Account Identity By Mapping

GET /api-account-identities/mapping/{clientId}

Authorization

This endpoint requires:

  • read action on this api-account-identity resource.

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

email

String

true

tenantId

String

true

Deprecated..

type

String

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/mapping/6a7ab1cc-2bfd-474d-8f68-36287c8592c7' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 698

{
  "id" : "ef7060d1-a3fc-4104-a96b-6eb5c105f76d",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ClientId" : "6a7ab1cc-2bfd-474d-8f68-36287c8592c7",
  "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" : 637860000,
    "epochSecond" : 1792735463
  },
  "updatedAt" : null,
  "deletedAt" : null,
  "tags" : { },
  "email" : "service.admin-59@foo.com",
  "tenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "type" : "ApiAccountIdentity"
}

Create Api Account Identity

POST /api-account-identities

Authorization

This endpoint requires:

  • create action on this api-account-identity resource.

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" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "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" : "2ab52755-efd2-40e4-85ee-22b74a615d52",
    "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "auth0ClientId" : null,
    "awsCognitoClientId" : "d3c06241-cddc-4290-9ff9-ce2fda0224cf|puncbhkv",
    "authenticationUrl" : "https://netfoundry-test-ewxhpm.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" : 529288000,
      "epochSecond" : 1792735428
    },
    "updatedAt" : null,
    "deletedAt" : null,
    "tags" : { },
    "email" : "hr.director@acme.com",
    "tenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
    "type" : "ApiAccountIdentity"
  },
  "clientId" : "puncbhkv",
  "password" : "fwqjjteuwedwtwvfnuhpjkdo",
  "authenticationUrl" : "https://netfoundry-test-ewxhpm.auth.us-east-1.amazoncognito.com/oauth2/token"
}

Update Identity Info

PUT /api-account-identities/{id}

Authorization

This endpoint requires:

  • update action on this api-account-identity resource.

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

email

String

true

tenantId

String

true

Deprecated..

type

String

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/c05b1d6c-9eaa-4d0c-8d56-bf02e1b85aa2' -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: 695

{
  "id" : "c05b1d6c-9eaa-4d0c-8d56-bf02e1b85aa2",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ClientId" : "658026f1-fdc9-4b0a-8366-8b1bc73d4e4b",
  "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" : 173901000,
    "epochSecond" : 1792735422
  },
  "updatedAt" : {
    "nano" : 32413000,
    "epochSecond" : 1792735423
  },
  "deletedAt" : null,
  "tags" : { },
  "email" : "robot@acme.com",
  "tenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "type" : "ApiAccountIdentity"
}

Activate Or Deactivate Api Account Identity

PUT /api-account-identities/{id}/{action:activate|deactivate}

Authorization

This endpoint requires:

  • update-active action on this api-account-identity resource.

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

email

String

true

tenantId

String

true

Deprecated..

type

String

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/api-account-identities/f120ca9d-737d-4ef5-813d-f5bb033103ce/deactivate' -i -X PUT

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 755

{
  "id" : "f120ca9d-737d-4ef5-813d-f5bb033103ce",
  "organizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "auth0ClientId" : "85ea8efd-f8ba-4752-81ff-9443e7bc5cdf",
  "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" : 252403000,
    "epochSecond" : 1792735463
  },
  "updatedAt" : {
    "nano" : 276304000,
    "epochSecond" : 1792735463
  },
  "deletedAt" : null,
  "tags" : { },
  "email" : "service.admin-41@foo.com",
  "tenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "type" : "ApiAccountIdentity"
}

Invitation

Find Invitations

GET /invitations

Authorization

This endpoint requires:

  • read action on this invitation resource.

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" : "640a6d75-36d1-4d8b-9a37-99a6d75fefd5",
  "fromIdentityId" : "4c6e3377-01ff-4ea8-b602-f61d8060c5ed",
  "toOrganizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "invitedEmailAddress" : "new.employee-292@acme.com",
  "invitationHost" : "cloudziti.io",
  "expiration" : {
    "nano" : 589742000,
    "epochSecond" : 1793340278
  },
  "targetUserIdentityId" : "5bcfc29e-f154-4ebf-a6f7-29d27ef6ba8b",
  "accepted" : null,
  "revokedAt" : {
    "nano" : 606276000,
    "epochSecond" : 1792735478
  },
  "responseReceivedAt" : {
    "nano" : 606278000,
    "epochSecond" : 1792735478
  },
  "state" : "Revoked",
  "toTenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c"
}, {
  "id" : "6484c00a-c6d2-4d58-bdc1-875d87e9bd85",
  "fromIdentityId" : "09978c3d-6bd6-429c-aae0-b0adb9d4dfc5",
  "toOrganizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "invitedEmailAddress" : "new.employee@acme.com",
  "invitationHost" : "acme.cloudziti.io",
  "expiration" : {
    "nano" : 349482000,
    "epochSecond" : 1793340278
  },
  "targetUserIdentityId" : "79cf7105-8373-4cf9-ba83-a3eb072ec2a9",
  "accepted" : null,
  "revokedAt" : null,
  "responseReceivedAt" : null,
  "state" : "Open",
  "toTenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c"
}, {
  "id" : "7d50c35d-1607-4ad2-abf9-286cc21f4060",
  "fromIdentityId" : "4c6e3377-01ff-4ea8-b602-f61d8060c5ed",
  "toOrganizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "invitedEmailAddress" : "new.employee-285@acme.com",
  "invitationHost" : "cloudziti.io",
  "expiration" : {
    "nano" : 165596000,
    "epochSecond" : 1793340278
  },
  "targetUserIdentityId" : "9fbe87fe-6a32-4e9a-bb57-357accec6a9e",
  "accepted" : false,
  "revokedAt" : null,
  "responseReceivedAt" : {
    "nano" : 197038000,
    "epochSecond" : 1792735478
  },
  "state" : "Declined",
  "toTenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c"
} ]

Get Invitation By Id

GET /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

Authorization

This endpoint requires:

  • read action on this invitation resource.

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/48528471-1320-4854-83cd-c768052cb177' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 561

{
  "id" : "48528471-1320-4854-83cd-c768052cb177",
  "fromIdentityId" : "4c6e3377-01ff-4ea8-b602-f61d8060c5ed",
  "toOrganizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "invitedEmailAddress" : "new.employee-305@acme.com",
  "invitationHost" : "cloudziti.io",
  "expiration" : {
    "nano" : 147000,
    "epochSecond" : 1793340279
  },
  "targetUserIdentityId" : "dcdaf9be-4e65-4b43-9aaf-ef105400e35e",
  "accepted" : null,
  "revokedAt" : null,
  "responseReceivedAt" : null,
  "state" : "Open",
  "toTenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c"
}

Create Invitation

POST /invitations

Authorization

This endpoint requires:

  • create action on this invitation resource.

  • read action on the user-identity resource identified by the targetUserIdentityId property.

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" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "invitedEmailAddress" : "new.employee@acme.com",
  "invitationUrl" : "http://acme.cloudziti.io/invitation",
  "targetUserIdentityId" : "79cf7105-8373-4cf9-ba83-a3eb072ec2a9"
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 565

{
  "id" : "6484c00a-c6d2-4d58-bdc1-875d87e9bd85",
  "fromIdentityId" : "09978c3d-6bd6-429c-aae0-b0adb9d4dfc5",
  "toOrganizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "invitedEmailAddress" : "new.employee@acme.com",
  "invitationHost" : "acme.cloudziti.io",
  "expiration" : {
    "nano" : 349482000,
    "epochSecond" : 1793340278
  },
  "targetUserIdentityId" : "79cf7105-8373-4cf9-ba83-a3eb072ec2a9",
  "accepted" : null,
  "revokedAt" : null,
  "responseReceivedAt" : null,
  "state" : "Open",
  "toTenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c"
}

Respond To Invitation

PUT /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}/{action:accept|decline}

Authorization

This endpoint requires:

  • update-respond action on this invitation resource.

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/f74361bd-2ecf-49e8-ab53-76bddb85967f/decline' -i -X PUT

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 625

{
  "id" : "f74361bd-2ecf-49e8-ab53-76bddb85967f",
  "fromIdentityId" : "4c6e3377-01ff-4ea8-b602-f61d8060c5ed",
  "toOrganizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "invitedEmailAddress" : "new.employee-297@acme.com",
  "invitationHost" : "cloudziti.io",
  "expiration" : {
    "nano" : 797955000,
    "epochSecond" : 1793340278
  },
  "targetUserIdentityId" : "cc1774a1-096c-43a4-8c8b-ad3e6a979bd5",
  "accepted" : false,
  "revokedAt" : null,
  "responseReceivedAt" : {
    "nano" : 819168000,
    "epochSecond" : 1792735478
  },
  "state" : "Declined",
  "toTenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c"
}

Revoke Invitation

PUT /invitations/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}/revoke

Authorization

This endpoint requires:

  • update-revoke action on this invitation resource.

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/17c10948-6baf-46bf-8d42-325f45efcc48/revoke' -i -X PUT

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 679

{
  "id" : "17c10948-6baf-46bf-8d42-325f45efcc48",
  "fromIdentityId" : "4c6e3377-01ff-4ea8-b602-f61d8060c5ed",
  "toOrganizationId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c",
  "invitedEmailAddress" : "new.employee-313@acme.com",
  "invitationHost" : "cloudziti.io",
  "expiration" : {
    "nano" : 160222000,
    "epochSecond" : 1793340279
  },
  "targetUserIdentityId" : "702f94a5-fcf4-4b4f-9a37-a4fa3e29c5d6",
  "accepted" : null,
  "revokedAt" : {
    "nano" : 168922000,
    "epochSecond" : 1792735479
  },
  "responseReceivedAt" : {
    "nano" : 168924000,
    "epochSecond" : 1792735479
  },
  "state" : "Revoked",
  "toTenantId" : "98e5b6a6-d7de-4afd-9bdf-219657ce495c"
}

Support

Create Support Request

POST /nfconsole/support/requests

Authorization

Authorization not required for this request.

Request fields

Path Type Optional Description

name

String

true

email

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/8MBj9zvTD3xldVJ9n6KAwtAZobOzpHCArudz' -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-347@acme.com"
  },
  "invitedEmailAddress" : "new.employee-349@acme.com",
  "toOrganizationName" : "ACME International, Inc.",
  "toOrganizationLabel" : "ACME-322",
  "expiration" : {
    "nano" : 705700000,
    "epochSecond" : 1793340283
  },
  "accepted" : null,
  "state" : "Open",
  "toTenantName" : "ACME International, Inc.",
  "toTenantLabel" : "ACME-322"
}

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/EFoHk2mqhraiRhHbDUr93wJ7CMYvUNzOy2Oe/decline' -i -X PUT

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 528

{
  "fromIdentity" : {
    "name" : "John Doe",
    "email" : "john.doe@acme.com"
  },
  "targetIdentity" : {
    "name" : "First Last",
    "email" : "random-332@acme.com"
  },
  "invitedEmailAddress" : "new.employee-334@acme.com",
  "toOrganizationName" : "ACME International, Inc.",
  "toOrganizationLabel" : "ACME-322",
  "expiration" : {
    "nano" : 165985000,
    "epochSecond" : 1793340283
  },
  "accepted" : false,
  "state" : "Declined",
  "toTenantName" : "ACME International, Inc.",
  "toTenantLabel" : "ACME-322"
}

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/pjII3bLxXbETZMBuTKiGRyomN186o0KbefpZ/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.eyJpYXQiOjE3OTI3MzU0ODMsImV4cCI6MTc5MjczNjM4MywiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiZmxvdyI6Imludml0YXRpb24iLCJpbnZpdGF0aW9uSWQiOiJjYjI2ZGYwMy04YzVjLTRiYTUtYTcxYS1hOTg0MDE4MGI1NjQiLCJ0ZW5hbnRMYWJlbCI6IkFDTUUtMzIyIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMzI0IiwiYXV0aDAtb3BhcXVlLWNvbm5lY3Rpb25JZC0zMjMiXSwicmVkaXJlY3RVcmwiOiJodHRwOi8vY29uc29sZS5uZmFkbWluLm5ldGZvdW5kcnkuaW8vaW52aXRhdGlvbiJ9.QrzqIgyzOaY0BAuoG9d-qXFVed9VwQK-6t2p6U0XdIjdN_rB-vas7sRtZZi2p17w0OjQpk31e2I-KQNeQDROljO_FpBe5CojD3izdpHF6E_U4gXagVgjNTBpIMEugsxNMr6Tmhm-BOtX1ixLzD3QzVQq2RRXof5gv4X-vciLYVmvT5MwQIVXWl66juFEu6tNu_P0XTVm8q4H9OY_KI88CSdNPhVTmBknhOW3bTiZXyChNYMpK_H6gNnp-7idEqwnpYjwTrvHa1bSHLUUlBGbDgrckyjYajv49mh_UkBkPmKENNecZG-tbUJR8lMV0yzHYq1cGZB-UwCNrXcJu4NoTg",
  "auth0ConnectionIds" : [ "auth0-opaque-connectionId-324", "auth0-opaque-connectionId-323" ]
}

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.eyJpYXQiOjE3OTI3MzU0ODQsImV4cCI6MTc5MjczNjM4NCwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lkZW50aXR5L3YxIiwiYXVkIjoiaHR0cHM6Ly9uZXRmb3VuZHJ5LXNhbmRib3guYXV0aDAuY29tLyIsImZsb3ciOiJsb2dpbiIsInRlbmFudExhYmVsIjoiQUNNRS0yIiwiYXV0aDBDb25uZWN0aW9uSWRzIjpbImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtMyIsImF1dGgwLW9wYXF1ZS1jb25uZWN0aW9uSWQtNCJdLCJyZWRpcmVjdFVybCI6Imh0dHA6Ly9jb25zb2xlLm5mYWRtaW4ubmV0Zm91bmRyeS5pby9pbnZpdGF0aW9uIn0.JguWOPPoh9EXAeN04TAlINywDx5a3YLIQxDT_HC0Ry_VI6eQWhpapKoR6PkPApAUm2E0EUbh4AFGNHDOBLszp-w9WyD-jUBvQjXIFqr0b8uao1LkHEnOUGeZ_FZnJgz4JEMmINH5oKflnwi_YKOgpf_0fg8gxK2t4dTn5WAhArveIfazIV0o2ndjfWrriquFEibjlNxvpLmBi3kV2FiUzDESxDOVaF99902eloF6BD6wvhNxt6U2fR6zCesKfpIr_4HCJaQt4GODO7leZlonV4EcguKUTI_o1ZxHfInDW7YTm8yxAwGusAx7E55t5AQM2PDy6BZt-Kn3-erhalHxVA",
  "auth0ConnectionIds" : [ "auth0-opaque-connectionId-3", "auth0-opaque-connectionId-4" ]
}

Identity Preference Flow

Find Identity Preferences

GET /identity-preferences

Authorization

This endpoint requires:

  • read action on this identity-preference resource.

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" : "460e18c1-adb4-4ae1-8048-5c9e666540d3",
  "userIdentityId" : "f1b2063f-189e-430c-a61b-5b02a4a99ed7",
  "preferences" : {
    "first" : "my first preference."
  },
  "createdBy" : "f1b2063f-189e-430c-a61b-5b02a4a99ed7",
  "createdAt" : {
    "nano" : 830938000,
    "epochSecond" : 1792735474
  },
  "updatedAt" : {
    "nano" : 830938000,
    "epochSecond" : 1792735474
  },
  "deletedBy" : null,
  "deletedAt" : null
}, {
  "id" : "5e344b9f-0a2c-4f0a-aeef-bae72a125ba9",
  "userIdentityId" : "d0a646f1-9da9-4f17-b81b-e8e1f18a6ff0",
  "preferences" : {
    "first" : "my first preference."
  },
  "createdBy" : "d0a646f1-9da9-4f17-b81b-e8e1f18a6ff0",
  "createdAt" : {
    "nano" : 770420000,
    "epochSecond" : 1792735474
  },
  "updatedAt" : {
    "nano" : 770420000,
    "epochSecond" : 1792735474
  },
  "deletedBy" : null,
  "deletedAt" : null
}, {
  "id" : "8bee5701-6bdb-4013-9f99-ff85e61d93cd",
  "userIdentityId" : "97ee649f-8e7f-4c84-a2f3-c4b1f557bccd",
  "preferences" : {
    "first" : "my first preference."
  },
  "createdBy" : "97ee649f-8e7f-4c84-a2f3-c4b1f557bccd",
  "createdAt" : {
    "nano" : 882463000,
    "epochSecond" : 1792735474
  },
  "updatedAt" : {
    "nano" : 882463000,
    "epochSecond" : 1792735474
  },
  "deletedBy" : null,
  "deletedAt" : null
} ]

Get Identity Preference

GET /identity-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

Authorization

This endpoint requires:

  • read action on this identity-preference resource.

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/322d4f9e-8831-4341-acbe-fd57bce0ebb5' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415

{
  "id" : "322d4f9e-8831-4341-acbe-fd57bce0ebb5",
  "userIdentityId" : "659b82f9-636b-4469-8a64-ddcf2a58bbc3",
  "preferences" : {
    "hello" : "world"
  },
  "createdBy" : "659b82f9-636b-4469-8a64-ddcf2a58bbc3",
  "createdAt" : {
    "nano" : 304869000,
    "epochSecond" : 1792735476
  },
  "updatedAt" : {
    "nano" : 304869000,
    "epochSecond" : 1792735476
  },
  "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" : "c97a9fb3-2ab6-4b4d-a0f6-3d8eaf5009e2",
  "userIdentityId" : "231f9a25-eb2e-4165-a85a-7c981dcdc9b1",
  "preferences" : {
    "first" : "my first preference."
  },
  "createdBy" : "231f9a25-eb2e-4165-a85a-7c981dcdc9b1",
  "createdAt" : {
    "nano" : 268966000,
    "epochSecond" : 1792735475
  },
  "updatedAt" : {
    "nano" : 268966000,
    "epochSecond" : 1792735475
  },
  "deletedBy" : null,
  "deletedAt" : null
}

Upsert Identity Preference By Id

PUT /identity-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

Authorization

This endpoint requires:

  • create action on this identity-preference resource.

  • update action on this identity-preference resource.

Path parameters

Parameter Type Optional Description

id

Object

false

Request fields

Path Type Optional Description

userIdentityId

String

true

preferences

Object

true

Response fields

Path Type Optional Description

id

String

true

userIdentityId

String

true

preferences

Object

true

createdBy

String

true

createdAt

Object

true

updatedAt

Object

true

deletedBy

String

true

deletedAt

Object

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/identity-preferences/63e97ec4-40db-4c07-b455-fd3cc6763e19' -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" : "63e97ec4-40db-4c07-b455-fd3cc6763e19",
  "userIdentityId" : "47bbebde-317f-4041-8d44-dd7af50ed315",
  "preferences" : {
    "updated" : "my second preference."
  },
  "createdBy" : "47bbebde-317f-4041-8d44-dd7af50ed315",
  "createdAt" : {
    "nano" : 123296000,
    "epochSecond" : 1792735477
  },
  "updatedAt" : {
    "nano" : 136494000,
    "epochSecond" : 1792735477
  },
  "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}}

Authorization

This endpoint requires:

  • delete action on this identity-preference resource.

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/7abc02d6-b4c9-42bc-8d71-e818db30988b' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505

{
  "id" : "7abc02d6-b4c9-42bc-8d71-e818db30988b",
  "userIdentityId" : "e531586f-1788-4dbf-a7dc-42ef7beef89f",
  "preferences" : {
    "hello" : "world"
  },
  "createdBy" : "e531586f-1788-4dbf-a7dc-42ef7beef89f",
  "createdAt" : {
    "nano" : 852056000,
    "epochSecond" : 1792735475
  },
  "updatedAt" : {
    "nano" : 896491000,
    "epochSecond" : 1792735475
  },
  "deletedBy" : "4e63a6fd-d3af-4ee5-a5ca-0cad5943eee6",
  "deletedAt" : {
    "nano" : 896000000,
    "epochSecond" : 1792735475
  }
}

Organization Preference Flow

Find Organization Preferences

GET /organization-preferences

Authorization

This endpoint requires:

  • read action on this organization-preference resource.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

true

organizationId

String

true

preferences

Object

true

createdBy

String

true

createdAt

Object

true

updatedAt

Object

true

deletedBy

String

true

deletedAt

Object

true

Example request

$ curl 'https://gateway.netFoundry.io/identity/v1/organization-preferences' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1266

[ {
  "id" : "3519b0bd-6afc-4fcf-8189-e7e8b8fc8f90",
  "organizationId" : "48d00921-52e6-4831-89e6-073bd3e2f521",
  "preferences" : {
    "hello" : "world"
  },
  "createdBy" : "052de17c-d7e7-4b7d-aad1-9b69d6a710ea",
  "createdAt" : {
    "nano" : 196945000,
    "epochSecond" : 1792735488
  },
  "updatedAt" : {
    "nano" : 196945000,
    "epochSecond" : 1792735488
  },
  "deletedBy" : null,
  "deletedAt" : null
}, {
  "id" : "ca528ef8-8c12-48ef-b4fb-7e071a732278",
  "organizationId" : "745efb29-72e8-4827-b9dd-2021038041ba",
  "preferences" : {
    "first" : "my first preference."
  },
  "createdBy" : "635716f7-ab4b-4aba-9a18-57f014c084b1",
  "createdAt" : {
    "nano" : 120465000,
    "epochSecond" : 1792735488
  },
  "updatedAt" : {
    "nano" : 120465000,
    "epochSecond" : 1792735488
  },
  "deletedBy" : null,
  "deletedAt" : null
}, {
  "id" : "ff6559e7-9055-4477-ae30-ecc7754b2798",
  "organizationId" : "15fd8acc-0db4-4d1a-941a-7aab91a6ce9b",
  "preferences" : {
    "hello" : "world"
  },
  "createdBy" : "cd6c2959-eba0-4075-8e81-dd97fa5cfe1e",
  "createdAt" : {
    "nano" : 42510000,
    "epochSecond" : 1792735488
  },
  "updatedAt" : {
    "nano" : 42510000,
    "epochSecond" : 1792735488
  },
  "deletedBy" : null,
  "deletedAt" : null
} ]

Get Organization Preference

GET /organization-preferences/{id:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

Authorization

This endpoint requires:

  • read action on this organization-preference resource.

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/3519b0bd-6afc-4fcf-8189-e7e8b8fc8f90' -i -X GET

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 415

{
  "id" : "3519b0bd-6afc-4fcf-8189-e7e8b8fc8f90",
  "organizationId" : "48d00921-52e6-4831-89e6-073bd3e2f521",
  "preferences" : {
    "hello" : "world"
  },
  "createdBy" : "052de17c-d7e7-4b7d-aad1-9b69d6a710ea",
  "createdAt" : {
    "nano" : 196945000,
    "epochSecond" : 1792735488
  },
  "updatedAt" : {
    "nano" : 196945000,
    "epochSecond" : 1792735488
  },
  "deletedBy" : null,
  "deletedAt" : null
}

Create Organization Preference

POST /organization-preferences

Authorization

This endpoint requires:

  • create action on this organization-preference resource.

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" : "745efb29-72e8-4827-b9dd-2021038041ba",
  "preferences" : {
    "first" : "my first preference."
  }
}'

Example response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 430

{
  "id" : "ca528ef8-8c12-48ef-b4fb-7e071a732278",
  "organizationId" : "745efb29-72e8-4827-b9dd-2021038041ba",
  "preferences" : {
    "first" : "my first preference."
  },
  "createdBy" : "635716f7-ab4b-4aba-9a18-57f014c084b1",
  "createdAt" : {
    "nano" : 120465000,
    "epochSecond" : 1792735488
  },
  "updatedAt" : {
    "nano" : 120465000,
    "epochSecond" : 1792735488
  },
  "deletedBy" : null,
  "deletedAt" : null
}

Update Organization Preference

PUT /organization-preferences/{id}

Authorization

This endpoint requires:

  • update action on this organization-preference resource.

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/a6544cb0-5840-47a0-a591-889aba86ffc4' -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" : "a6544cb0-5840-47a0-a591-889aba86ffc4",
  "organizationId" : "1ab7ea0a-a06a-4748-a986-7cc3ab65de1f",
  "preferences" : {
    "updated" : "my second preference."
  },
  "createdBy" : "4aaa4ba7-e8b2-4378-b71e-3a9668bd112e",
  "createdAt" : {
    "nano" : 315117000,
    "epochSecond" : 1792735488
  },
  "updatedAt" : {
    "nano" : 328240000,
    "epochSecond" : 1792735488
  },
  "deletedBy" : null,
  "deletedAt" : null
}

Delete Organization Preference

DELETE /organization-preferences/{id}

Authorization

This endpoint requires:

  • delete action on this organization-preference resource.

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/0db34712-032a-408f-88fd-b6b786268824' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 505

{
  "id" : "0db34712-032a-408f-88fd-b6b786268824",
  "organizationId" : "83eb31e0-ca2c-4a15-a6e5-c42a6bba7341",
  "preferences" : {
    "hello" : "world"
  },
  "createdBy" : "35623d8c-9846-4aea-ad25-696de6f94664",
  "createdAt" : {
    "nano" : 155416000,
    "epochSecond" : 1792735488
  },
  "updatedAt" : {
    "nano" : 165001000,
    "epochSecond" : 1792735488
  },
  "deletedBy" : "ca477296-afb6-4489-acb4-c2d7560019f0",
  "deletedAt" : {
    "nano" : 164000000,
    "epochSecond" : 1792735488
  }
}