Konnect Identity (3.0.0)

Download OpenAPI specification:Download

URL: https://konghq.com

The management API for Kong Konnect Identity resources.

Auth Settings

Get Auth Settings

Returns authentication configuration, which determines how users can log in and how they are assigned to teams.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Responses

Response samples

200
401

Content type

application/json

{"oidc_auth_enabled": true,
"saml_auth_enabled": false,
"basic_auth_enabled": false,
"idp_mapping_enabled": false,
"konnect_mapping_enabled": true
}

Update Auth Settings

Updates authentication configuration.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

The request schema to update an organization's authentication settings.

basic_auth_enabled	boolean The organization has basic auth enabled.
oidc_auth_enabled	boolean The organization has OIDC disabled.
saml_auth_enabled	boolean The organization has SAML disabled.
idp_mapping_enabled	boolean Whether IdP groups determine the Konnect teams a user has.
konnect_mapping_enabled	boolean Whether a Konnect Identity Admin assigns teams to a user.

Responses

Request samples

Payload

Content type

application/json

{"oidc_auth_enabled": false,
"saml_auth_enabled": false,
"basic_auth_enabled": true,
"idp_mapping_enabled": false,
"konnect_mapping_enabled": true
}

Response samples

200
400
401
403

Content type

application/json

{"oidc_auth_enabled": true,
"saml_auth_enabled": false,
"basic_auth_enabled": false,
"idp_mapping_enabled": false,
"konnect_mapping_enabled": true
}

Retrieve Identity Providers

Retrieves the identity providers available within the organization. This operation provides information about various identity providers for SAML or OIDC authentication integrations.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

query Parameters

object

Filter identity providers returned in the response.

Responses

Response samples

200
401
403

Content type

application/json

[{"id": "a2c3156d-ebb1-432b-b2f1-edcc5f133c60",
"type": "saml",
"enabled": true,
"login_path": "the-saml-konnect-org",
"config": {"idp_metadata_url": "https://mocksaml.com/api/saml/metadata",
"sp_entity_id": "https://cloud.konghq.com/sp/00000000-0000-0000-0000-000000000000",
"sp_metadata_url": "https://cloud.konghq.com/v2/authenticate/the-saml-konnect-org/saml/metadata",
"login_url": "https://cloud.konghq.com/login/the-saml-konnect-org",
"callback_url": "https://cloud.konghq.com/v2/authenticate/the-saml-konnect-org/saml/acs"
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-02-07T17:46:57.52Z"
},
{"id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
"type": "oidc",
"enabled": false,
"login_path": "the-oidc-konnect-org",
"config": {"issuer_url": "https://konghq.okta.com/oauth2/default",
"client_id": "0oaqhb43ckTZ02j1F357",
"scopes": ["openid",
"email",
"profile"
],
"claim_mappings": {"email": "email",
"name": "name",
"groups": "groups"
}
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-02-07T17:46:57.52Z"
}
]

Create Identity Provider

Creates a new identity provider. This operation allows the creation of a new identity provider for authentication purposes.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

An object representing the configuration for creating a new identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

type	string (IdentityProviderType) Enum: "oidc" "saml" Specifies the type of identity provider.
login_path	string (Identity Provider Login Path Property) The path used for initiating login requests with the identity provider.
	OIDC Identity Provider Config (object) or SAML Identity Provider Config (object)

Responses

Request samples

Payload

Content type

application/json

Example

OIDC Identity Provider Request

{"type": "oidc",
"login_path": "the-oidc-konnect-org",
"config": {"issuer_url": "https://konghq.okta.com/oauth2/default",
"client_id": "0oaqhb43ckTZ02j1F357",
"client_secret": "BbqwI8xP9E4evOK",
"scopes": ["openid",
"email",
"profile"
],
"claim_mappings": {"email": "email",
"name": "name",
"groups": "groups"
}
}
}

Response samples

201
400
401
403

Content type

application/json

Example

OIDC Identity Provider

{"id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
"type": "oidc",
"enabled": false,
"login_path": "the-oidc-konnect-org",
"config": {"issuer_url": "https://konghq.okta.com/oauth2/default",
"client_id": "0oaqhb43ckTZ02j1F357",
"scopes": ["openid",
"email",
"profile"
],
"claim_mappings": {"email": "email",
"name": "name",
"groups": "groups"
}
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-02-07T17:46:57.52Z"
}

Get Identity Provider

Retrieves the configuration of a single identity provider. This operation returns information about a specific identity provider's settings and authentication integration details.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the identity provider.

Responses

Response samples

200
400
401
403
404

Content type

application/json

Example

OIDC Identity Provider

{"id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
"type": "oidc",
"enabled": false,
"login_path": "the-oidc-konnect-org",
"config": {"issuer_url": "https://konghq.okta.com/oauth2/default",
"client_id": "0oaqhb43ckTZ02j1F357",
"scopes": ["openid",
"email",
"profile"
],
"claim_mappings": {"email": "email",
"name": "name",
"groups": "groups"
}
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-02-07T17:46:57.52Z"
}

Update Identity Provider

Updates the configuration of an existing identity provider. This operation allows modifications to be made to an existing identity provider's configuration.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the identity provider.

Request Body schema: application/json

An object representing the configuration for updating an identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

enabled	boolean (Identity Provider Enabled Property) Default: false Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.
login_path	string (Identity Provider Login Path Property) The path used for initiating login requests with the identity provider.
	OIDC Identity Provider Config (object) or SAML Identity Provider Config (object)

Responses

Request samples

Payload

Content type

application/json

Example

Update OIDC Identity Provider

{"enabled": true,
"login_path": "the-oidc-konnect-org",
"config": {"issuer_url": "https://konghq.okta.com/oauth2/default",
"client_id": "0oaqhb43ckTZ02j1F357",
"client_secret": "BbqwI8xP9E4evOK",
"scopes": ["openid",
"email",
"profile"
],
"claim_mappings": {"email": "email",
"name": "name",
"groups": "groups"
}
}
}

Response samples

200
400
401
403
404

Content type

application/json

Example

OIDC Identity Provider

{"id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
"type": "oidc",
"enabled": false,
"login_path": "the-oidc-konnect-org",
"config": {"issuer_url": "https://konghq.okta.com/oauth2/default",
"client_id": "0oaqhb43ckTZ02j1F357",
"scopes": ["openid",
"email",
"profile"
],
"claim_mappings": {"email": "email",
"name": "name",
"groups": "groups"
}
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-02-07T17:46:57.52Z"
}

Delete Identity Provider

Deletes an existing identity provider configuration. This operation removes a specific identity provider from the organization.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the identity provider.

Responses

Response samples

400
401
403
404

Content type

application/problem+json

Example

Request Format is Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

Fetch IdP Configuration

Fetch the IdP configuration.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"issuer": "https://myidp.com/oauth2",
"login_path": "myapp",
"client_id": "YOUR_CLIENT_ID",
"scopes": ["email",
"openid",
"profile"
],
"claim_mappings": {"name": "name",
"email": "email",
"groups": "custom-groups-claim"
}
}

Update IdP Configuration

Update the IdP configuration.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

The request schema for the update IdP configuration request.

issuer	string <uri>
login_path	string
client_id	string
client_secret	string
scopes	Array of strings Default: ["email","openid","profile"]
	object >= 3 properties

Responses

Request samples

Payload

Content type

application/json

{"issuer": "https://myidp.com/oauth2",
"login_path": "myapp",
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"scopes": ["email",
"openid",
"profile"
],
"claim_mappings": {"name": "name",
"email": "email",
"groups": "custom-group-claim"
}
}

Response samples

200
400
401
403

Content type

application/json

{"issuer": "https://myidp.com/oauth2",
"login_path": "myapp",
"client_id": "YOUR_CLIENT_ID",
"scopes": ["email",
"openid",
"profile"
],
"claim_mappings": {"name": "name",
"email": "email",
"groups": "custom-groups-claim"
}
}

Update Team Mappings

Updates the IdP group to Konnect team mapping.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

The request schema for updating IdP team mappings.

Array of objects

The mappings object.

Responses

Request samples

Payload

Content type

application/json

{"mappings": [{"group": "API Engineers",
"team_ids": ["af91db4c-6e51-403e-a2bf-33d27ae50c0a"
]
}
]
}

Response samples

200
400
401
404
412

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 1,
"total": 10
}
},
"data": [{"group": "Service Developers",
"team_ids": ["6801e673-cc10-498a-94cd-4271de07a0d3"
]
}
]
}

Fetch Team Mapping

Fetch the IdP group to Konnect team mapping.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.

Responses

Response samples

200
401
403
404
412

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 6
}
},
"data": [{"group": "111(@&*$)(@*#_@(gfds re gdsf dfg",
"team_ids": ["c0010105-e840-4824-b7ee-787f22267c36"
]
},
{"group": "2222",
"team_ids": ["af91db4c-6e51-403e-a2bf-33d27ae50c0a"
]
}
]
}

Fetch Team Group Mappings

Retrieves the mappings between Konnect Teams and Identity Provider Groups. Returns a 400 error if an Identity Provider has not yet been configured.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.

Responses

Response samples

200
400
401
403

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 1,
"total": 10
}
},
"data": [{"groups": ["Service Developers"
],
"team_id": "6801e673-cc10-498a-94cd-4271de07a0d3"
}
]
}

Patch Mappings by Team ID

Allows partial updates to the mappings between Konnect Teams and Identity Provider Groups. The request body must be keyed on team ID. For a given team ID, the given group list is a complete replacement. To remove all mappings for a given team, provide an empty group list.

Returns a 400 error if an Identity Provider has not yet been configured, or if a team ID in the request body is not found or is not a UUID.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

The request schema for a partial update of mappings from Konnect Teams to IdP Groups.

Array of objects

The IdP groups to map to the given team.

Responses

Request samples

Payload

Content type

application/json

{"data": [{"team_id": "af91db4c-6e51-403e-a2bf-33d27ae50c0a",
"groups": ["Team Leads",
"API Engineers"
]
}
]
}

Response samples

200
400
401
403

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 1,
"total": 10
}
},
"data": [{"groups": ["Service Developers"
],
"team_id": "6801e673-cc10-498a-94cd-4271de07a0d3"
}
]
}

Invites

Invite User

Sends an invitation email to invite a user to the Konnect organization. The email contains a link with a one time token to accept the invitation. Upon accepting the invitation, the user is directed to https://cloud.konghq.com/login to complete registration.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

The request schema for the invite user request.

If you pass an email that is not already an active user in the request, a fresh invitation email will be created and sent to the new user.

email

required

string <email>

Responses

Request samples

Payload

Content type

application/json

{"email": "james.c.woods@example.com"
}

Response samples

400
409
429

Content type

application/problem+json

Example

Request Format is Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

Roles

Get Predefined Roles

Retrieves the predefined, or system managed, roles.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Responses

Response samples

200
400
401

Content type

application/json

{"control_planes": {"name": "Control Planes",
"roles": {"admin": {"name": "Admin",
"description": "This role grants full write access to all entities within a control plane."
},
"certificate_admin": {"name": "Certificate Admin",
"description": "This role grants full write access to administer certificates."
},
"consumer_admin": {"name": "Consumer Admin",
"description": "This role grants full write access to administer consumers."
},
"creator": {"name": "Creator",
"description": "Creates a new Control Plane in an organization. The creator becomes the owner of the Control Plane they create."
},
"deployer": {"name": "Deployer",
"description": "This role grants full write access to administer services, routes and plugins necessary to deploy services in Service Hub."
},
"gateway_service_admin": {"name": "Gateway Service Admin",
"description": "This role grants full write access to administer gateway services."
},
"plugin_admin": {"name": "Plugin Admin",
"description": "This role grants full write access to administer plugins."
},
"route_admin": {"name": "Route Admin",
"description": "This role grants full write access to administer routes."
},
"sni_admin": {"name": "SNI Admin",
"description": "This role grants full write access to administer SNIs."
},
"upstream_admin": {"name": "Upstream Admin",
"description": "This role grants full write access to administer upstreams."
},
"viewer": {"name": "Viewer",
"description": "This role grants read only access to all entities within a control plane."
}
}
},
"api_products": {"name": "API Products",
"roles": {"admin": {"name": "Admin",
"description": "This role grants full write access to an API product and its versions."
},
"application_registration": {"name": "Application Registration",
"description": "This role grants permission to enable and disable application registration on an API product."
},
"creator": {"name": "Creator",
"description": "This access is required to create API products. This access is not for creating sub-entities such as versions, API specs, etc."
},
"deployer": {"name": "Deployer",
"description": "This role grants permission to deploy and remove an API product from a control plane."
},
"maintainer": {"name": "Maintainer",
"description": "This role grants all write permission to manage an API product and to administer plugins."
},
"plugins_admin": {"name": "Plugins Admin",
"description": "This role grants full write permission to administer plugins."
},
"publisher": {"name": "Publisher",
"description": "This role grants permission to publish an API product to one or more portals."
},
"viewer": {"name": "Viewer",
"description": "Viewer has read-only access to an API product and its sub-entities."
}
}
},
"audit_logs": {"name": "Audit Logs",
"roles": {"admin": {"name": "Admin",
"description": "This role grants full write access to the Audit log configuration."
}
}
},
"identity": {"name": "Identity",
"roles": {"admin": {"name": "Admin",
"description": "This role grants full write access to the Identity configuration."
}
}
},
"mesh_control_planes": {"name": "Mesh Control Plane",
"roles": {"admin": {"name": "Admin",
"description": "This role grants full write access to the related to Mesh control planes."
},
"connector": {"name": "Connector",
"description": "This role grants a mesh zone to connect to the mesh control plane in Konnect."
},
"creator": {"name": "Creator",
"description": "This role grants access to create new Mesh control planes."
},
"viewer": {"name": "Viewer",
"description": "This role grants access to read-only permissions to Mesh control planes."
}
}
}
}

List Team Roles

Lists the roles belonging to a team. Returns 400 if any filter parameters are invalid.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string <uuid>

Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The team ID

query Parameters

object

Filter roles returned in the response.

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "b02e23c5-8ee4-4e5a-99f4-43329923adcd",
"role_name": "Viewer",
"entity_id": "437c7192-fea0-4f35-8478-c8d57783f8c1",
"entity_type_name": "Control Planes",
"entity_region": "eu"
},
{"id": "869d9402-f117-4f9a-840f-69acaf70a81a",
"role_name": "Admin",
"entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
"entity_type_name": "Services",
"entity_region": "*"
}
]
}

Assign Team Role

Assigns a role to a team. Returns 409 if role is already assigned.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string <uuid>

Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The team ID

Request Body schema: application/json

The request schema for assigning a role.

role_name	string Enum: "Admin" "Appearance Maintainer" "Application Registration" "Certificate Admin" "Cloud Gateway Cluster Admin" "Cloud Gateway Cluster Viewer" "Consumer Admin" "Connector" "Creator" "Deployer" "Discovery Admin" "Discovery Viewer" "Gateway Service Admin" "Integration Admin" "Integration Viewer" "Key Admin" "Maintainer" "Network Admin" "Network Creator" "Network Viewer" "Plugin Admin" "Plugins Admin" "Product Publisher" "Publisher" "Route Admin" "SNI Admin" "Service Admin" "Service Creator" "Service Viewer" "Upstream Admin" "Vault Admin" "Viewer" The desired role.
entity_id	string <uuid> The ID of the entity.
entity_type_name	string Enum: "APIs" "API Products" "Application Auth Strategies" "Audit Logs" "Control Planes" "DCR Providers" "Identity" "Mesh Control Planes" "Networks" "Portals" "Service Hub" The type of entity.
entity_region	string Enum: "us" "eu" "au" "me" "in" "*" Region of the team.

Responses

Request samples

Payload

Content type

application/json

Example

Assigned Roles US

{"role_name": "Viewer",
"entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
"entity_type_name": "Control Planes",
"entity_region": "us"
}

Response samples

Content type

application/json

{"id": "eaf7adf1-32c8-4bbf-b960-d1f8456afe67",
"role_name": "Viewer",
"entity_id": "817d0422-45c9-4d88-8d64-45aef05c1ae7",
"entity_type_name": "Control Planes",
"entity_region": "eu"
}

Remove Team Role

Removes an assigned role from a team. Returns 404 if the requested team or assigned role were not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId required	string <uuid> Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe The team ID.
roleId required	string <uuid> Example: 8350205f-a305-4e39-abe9-bc082a80091a The role ID.

Responses

Response samples

400
401
403
404

Content type

application/problem+json

Example

Request Format is Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

List User Roles

Lists the roles assigned to a user. Returns 400 if any filter parameters are invalid.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

userId

required

string <uuid>

Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The user ID

query Parameters

object

Filter roles returned in the response.

Responses

Response samples

200
400
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "b02e23c5-8ee4-4e5a-99f4-43329923adcd",
"role_name": "Viewer",
"entity_id": "437c7192-fea0-4f35-8478-c8d57783f8c1",
"entity_type_name": "Control Planes",
"entity_region": "eu"
},
{"id": "869d9402-f117-4f9a-840f-69acaf70a81a",
"role_name": "Admin",
"entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
"entity_type_name": "Services",
"entity_region": "*"
}
]
}

Assign Role

Assigns a role to a user. Returns 409 if role is already assigned.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

userId

required

string <uuid>

Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The user ID

Request Body schema: application/json

The request schema for assigning a role.

role_name	string Enum: "Admin" "Appearance Maintainer" "Application Registration" "Certificate Admin" "Cloud Gateway Cluster Admin" "Cloud Gateway Cluster Viewer" "Consumer Admin" "Connector" "Creator" "Deployer" "Discovery Admin" "Discovery Viewer" "Gateway Service Admin" "Integration Admin" "Integration Viewer" "Key Admin" "Maintainer" "Network Admin" "Network Creator" "Network Viewer" "Plugin Admin" "Plugins Admin" "Product Publisher" "Publisher" "Route Admin" "SNI Admin" "Service Admin" "Service Creator" "Service Viewer" "Upstream Admin" "Vault Admin" "Viewer" The desired role.
entity_id	string <uuid> The ID of the entity.
entity_type_name	string Enum: "APIs" "API Products" "Application Auth Strategies" "Audit Logs" "Control Planes" "DCR Providers" "Identity" "Mesh Control Planes" "Networks" "Portals" "Service Hub" The type of entity.
entity_region	string Enum: "us" "eu" "au" "me" "in" "*" Region of the team.

Responses

Request samples

Payload

Content type

application/json

Example

Assigned Roles US

{"role_name": "Viewer",
"entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
"entity_type_name": "Control Planes",
"entity_region": "us"
}

Response samples

Content type

application/json

{"id": "eaf7adf1-32c8-4bbf-b960-d1f8456afe67",
"role_name": "Viewer",
"entity_id": "817d0422-45c9-4d88-8d64-45aef05c1ae7",
"entity_type_name": "Control Planes",
"entity_region": "eu"
}

Remove Role

Removes an assigned role from a user. Returns 404 if the requested user or assigned role were not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

userId required	string <uuid> Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe ID of the user.
roleId required	string <uuid> Example: 8350205f-a305-4e39-abe9-bc082a80091a ID of the role.

Responses

Response samples

400
401
404

Content type

application/problem+json

Example

Request Format is Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

Team Membership

List Team Users

Returns a paginated list of users that belong to the team specified in the path parameter.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the team.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object Filter users returned in the response.

Responses

Response samples

200
400
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 10
}
},
"data": [{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"email": "james.woods@email.com",
"full_name": "James Woods",
"preferred_name": "Jimmy",
"active": true,
"created_at": "2022-08-17T17:46:57.52Z",
"updated_at": "2022-10-03T17:00:00.00Z"
}
]
}

Add User

Adds a user to a team.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the team.

Request Body schema: application/json

The request schema for adding a user to a team.

id

required

string <uuid>

The user ID for the user being added to a team.

Responses

Request samples

Payload

Content type

application/json

{"id": "df120cb4-f60b-47bc-a2f8-6a28e6a3c63b"
}

Response samples

400
404
409

Content type

application/problem+json

Example

Request Format is Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

Remove User

Removes a user from a team. If the user was removed, returns a 204 empty response. Returns 404 if the user or team were not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

userId required	string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a User ID
teamId required	string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a Team ID.

Responses

Response samples

400
404

Content type

application/problem+json

Example

Request Format is Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

List User Teams

Returns a paginated list of a teams that the user belongs to.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

userId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The user ID.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object Filter teams returned in the response.

Responses

Response samples

200
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 1,
"total": 10
}
},
"data": [{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "IDM - Developers",
"description": "The developers for the IDM API.",
"system_team": false,
"labels": {"env": "test"
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-09-25T13:00:00.00Z"
}
]
}

Teams

List Teams

Returns an array of team objects containing information about the Konnect Teams.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object Filter teams returned in the response.

Responses

Response samples

200
400
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 1,
"total": 10
}
},
"data": [{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "IDM - Developers",
"description": "The developers for the IDM API.",
"system_team": false,
"labels": {"env": "test"
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-09-25T13:00:00.00Z"
}
]
}

Create Team

Creates a team in the Konnect Organization.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

The request schema for the create team request.

If you pass the same name and description of an existing team in the request, a team with the same name and description will be created. The two teams will have different team_id values to differentiate them.

name required	string^[\w \W]+$ A name for the team being created.
description	string <= 250 characters The description of the new team.
	object (Labels) <= 50 properties Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Payload

Content type

application/json

{"name": "IDM - Developers",
"description": "The Identity Management (IDM) team.",
"labels": {"env": "test",
"service": "test"
}
}

Response samples

201
400
403

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "IDM - Developers",
"description": "The developers for the IDM API.",
"system_team": false,
"labels": {"env": "test",
"service": "test"
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-09-25T13:00:00.00Z"
}

Fetch Team

Returns information about a team from a given team ID.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The team ID

Responses

Response samples

200
400
404

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "IDM - Developers",
"description": "The developers for the IDM API.",
"system_team": false,
"labels": {"env": "test",
"service": "test"
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-09-25T13:00:00.00Z"
}

Update Team

Updates an individual team.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The team ID

Request Body schema: application/json

The request schema for the update team request.

name	string^[\w \W]+$ The name of the team.
description	string <= 250 characters The description of the team.
	object or null (LabelsUpdate) <= 50 properties Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Labels are intended to store INTERNAL metadata. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Payload

Content type

application/json

{"name": "IDM - Developers",
"description": "The Identity Management (IDM) API team.",
"labels": {"env": "prod"
}
}

Response samples

200
400
404

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "IDM - Developers",
"description": "The developers for the IDM API.",
"system_team": false,
"labels": {"env": "test",
"service": "test"
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-09-25T13:00:00.00Z"
}

Delete Team

Deletes an individual team. Returns 404 if the team is not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The team ID

Responses

Response samples

400
404

Content type

application/problem+json

Example

Request Format is Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

Users

List Users

Returns a paginated list of user objects.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object Filter users returned in the response.

Responses

Response samples

200
400

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 10
}
},
"data": [{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"email": "james.woods@email.com",
"full_name": "James Woods",
"preferred_name": "Jimmy",
"active": true,
"created_at": "2022-08-17T17:46:57.52Z",
"updated_at": "2022-10-03T17:00:00.00Z"
}
]
}

Fetch User

Returns the user object for the user ID specified as a path parameter.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

userId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The ID of the user being deleted.

Responses

Response samples

200
400
404

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"email": "james.woods@email.com",
"full_name": "James Woods",
"preferred_name": "Jimmy",
"active": true,
"created_at": "1992-02-07T17:46:57.52Z",
"updated_at": "2022-02-07T17:00:00.52Z"
}

Update User

Update an individual user.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

userId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The ID of the user being deleted.

Request Body schema: application/json

The request schema for the update user request.

full_name	string^[\w \W]+$ The user's full name.
preferred_name	string <= 250 characters The user's desired name.

Responses

Request samples

Payload

Content type

application/json

{"full_name": "James C Woods",
"preferred_name": "Jimmy"
}

Response samples

200
401
403
404

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"email": "james.woods@email.com",
"full_name": "James Woods",
"preferred_name": "Jimmy",
"active": true,
"created_at": "1992-02-07T17:46:57.52Z",
"updated_at": "2022-02-07T17:00:00.52Z"
}

Delete User

Deletes an individual user. Returns 404 if the requested user was not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

userId

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The ID of the user being deleted.

Responses

Response samples

404

Content type

application/problem+json

{"status": 404,
"title": "Not Found",
"instance": "konnect:trace:2287285207635123011",
"detail": "The requested team was not found"
}

System Accounts

List System Accounts

Returns an array of system accounts (SA) in the organization. Returns 400 if any filter parameters are invalid.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object Filter system accounts returned in the response.

Responses

Response samples

200
400
401
403

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample System Account",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"konnect_managed": false
}
]
}

Create System Account

Creates a system account. Returns a 409 if a system account with the same name already exists.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

The request schema to create a system account.

name required	string Name of the system account.
description required	string Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnect_managed	boolean The system account is managed by Konnect (true/false).

Responses

Request samples

Payload

Content type

application/json

{"name": "Sample System Account",
"description": "This is a sample system account description.",
"konnect_managed": false
}

Response samples

201
401
403
409

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample System Account",
"description": "This is a sample system account description.",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"konnect_managed": false
}

Fetch System Account

Returns the system account (SA) for the SA ID specified as a path parameter.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId

required

string

ID of the system account.

Responses

Response samples

200
401
403
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample System Account",
"description": "This is a sample system account description.",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"konnect_managed": false
}

Update System Account

Updates the specified system account. Returns a 409 if the updated name is the same as another system account in the organization.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId

required

string

ID of the system account.

Request Body schema: application/json

The request schema for the update system account request.

name	string Name of the system account.
description	string Description of the system account.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200
401
403
404
409

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample System Account",
"description": "This is a sample system account description.",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"konnect_managed": false
}

Delete System Account

Deletes the specified system account. Returns 404 if the requested account was not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId

required

string

ID of the system account.

Responses

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthenticated",
"instance": "konnect:trace:952172606039454040",
"detail": "A valid token is required"
}

System Accounts - Access Tokens

List System Account Access Tokens

Returns the access tokens for the specified system account. Returns 400 if any filter parameters are invalid.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId

required

string

ID of the system account.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object Filter access tokens returned in the response.

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Access Token",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"last_used_at": "2019-08-24T14:15:22Z"
}
]
}

Create System Account Access Token

Creates an access token for the specified system account (SA). The access token can be used for authenticating API and CLI requests. The token will only be displayed once on creation. Returns a 409 if the system account already has a token with the same name.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId

required

string

ID of the system account.

Request Body schema: application/json

The request body to create a system account access token.

name	string
expires_at	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"name": "Sample Access Token",
"expires_at": "2019-08-24T14:15:22Z"
}

Response samples

201
401
403
404
409

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Access Token",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"last_used_at": "2019-08-24T14:15:22Z",
"token": "npat_12345678901234567890123456789012345678901234567890"
}

Fetch System Account Access Token

Returns the system account (SA) access token for the SA Access Token ID specified as a path parameter.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId required	string ID of the system account.
tokenId required	string ID of the system account access token.

Responses

Response samples

200
401
403
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Access Token",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"last_used_at": "2019-08-24T14:15:22Z"
}

Update System Account Access Token

Updates the specified access token. Returns a 409 if the updated name is the same as another token belonging to the specified system user.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId required	string ID of the system account.
tokenId required	string ID of the system account access token.

Request Body schema: application/json

name	string Name of the system account access token.

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
401
403
404
409

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample Access Token",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"last_used_at": "2019-08-24T14:15:22Z"
}

Delete System Account Access Token

Deletes the specified token. Returns 404 if the token was not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId required	string ID of the system account.
tokenId required	string ID of the system account access token.

Responses

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthenticated",
"instance": "konnect:trace:952172606039454040",
"detail": "A valid token is required"
}

System Accounts - Roles

Fetch Assigned Roles for System Account

Lists the roles belonging to a system account. Returns 400 if any filter parameters are invalid.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId

required

string

ID of the system account.

query Parameters

object

Filter roles returned in the response.

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "b02e23c5-8ee4-4e5a-99f4-43329923adcd",
"role_name": "Viewer",
"entity_id": "437c7192-fea0-4f35-8478-c8d57783f8c1",
"entity_type_name": "Control Planes",
"entity_region": "eu"
},
{"id": "869d9402-f117-4f9a-840f-69acaf70a81a",
"role_name": "Admin",
"entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
"entity_type_name": "Services",
"entity_region": "*"
}
]
}

Create Assigned Role for System Account

Assigns a role to a system account. Returns 409 if role is already assigned.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId

required

string

ID of the system account.

Request Body schema: application/json

The request schema for assigning a role.

role_name	string Enum: "Admin" "Appearance Maintainer" "Application Registration" "Certificate Admin" "Cloud Gateway Cluster Admin" "Cloud Gateway Cluster Viewer" "Consumer Admin" "Connector" "Creator" "Deployer" "Discovery Admin" "Discovery Viewer" "Gateway Service Admin" "Integration Admin" "Integration Viewer" "Key Admin" "Maintainer" "Network Admin" "Network Creator" "Network Viewer" "Plugin Admin" "Plugins Admin" "Product Publisher" "Publisher" "Route Admin" "SNI Admin" "Service Admin" "Service Creator" "Service Viewer" "Upstream Admin" "Vault Admin" "Viewer" The desired role.
entity_id	string <uuid> The ID of the entity.
entity_type_name	string Enum: "APIs" "API Products" "Application Auth Strategies" "Audit Logs" "Control Planes" "DCR Providers" "Identity" "Mesh Control Planes" "Networks" "Portals" "Service Hub" The type of entity.
entity_region	string Enum: "us" "eu" "au" "me" "in" "*" Region of the team.

Responses

Request samples

Payload

Content type

application/json

Example

Assigned Roles US

{"role_name": "Viewer",
"entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
"entity_type_name": "Control Planes",
"entity_region": "us"
}

Response samples

201
401
403
404
409

Content type

application/json

{"id": "eaf7adf1-32c8-4bbf-b960-d1f8456afe67",
"role_name": "Viewer",
"entity_id": "817d0422-45c9-4d88-8d64-45aef05c1ae7",
"entity_type_name": "Control Planes",
"entity_region": "eu"
}

Delete Assigned Role from System Account

Removes an assigned role from a system account. Returns 404 if the system account or assigned role were not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId required	string ID of the system account.
roleId required	string ID of the role.

Responses

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthenticated",
"instance": "konnect:trace:952172606039454040",
"detail": "A valid token is required"
}

System Accounts - Team Membership

List System Accounts on a Team

Returns a paginated list of system accounts that belong to the team specified in the path parameter.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string

ID of the team.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object Filter system accounts returned in the response.

Responses

Response samples

200
401
403
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Sample System Account",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"konnect_managed": false
}
]
}

Add System Account to a Team

Adds a system account to a team. Returns a 409 if the system account is already a member of the team.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId

required

string

ID of the team.

Request Body schema: application/json

The request schema for adding a system account to a team.

id	string <uuid> ID of the system account.

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

401
403
404
409

Content type

application/problem+json

{"status": 401,
"title": "Unauthenticated",
"instance": "konnect:trace:952172606039454040",
"detail": "A valid token is required"
}

Remove System Account From Team

Removes a system account from a team. Returns 404 if the team or system account were not found.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

teamId required	string ID of the team.
accountId required	string ID of the system account.

Responses

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthenticated",
"instance": "konnect:trace:952172606039454040",
"detail": "A valid token is required"
}

List Teams for a System Account

Returns a paginated list of a teams that the system account belongs to.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

accountId

required

string

ID of the system account.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
	object Filter teams returned in the response.

Responses

Response samples

200
401
403
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 1,
"total": 10
}
},
"data": [{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "IDM - Developers",
"description": "The developers for the IDM API.",
"system_team": false,
"labels": {"env": "test"
},
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-09-25T13:00:00.00Z"
}
]
}

Me

Retrieve My User Account

Returns the user account for the user identified in the token of the request.

Authorizations:

personalAccessTokenkonnectAccessToken

Responses

Response samples

200
401

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"email": "james.woods@email.com",
"full_name": "James Woods",
"preferred_name": "Jimmy",
"active": true,
"created_at": "1992-02-07T17:46:57.52Z",
"updated_at": "2022-02-07T17:00:00.52Z"
}

Retrieve My Organization

Returns the organization of the user identified in the token of the request.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Responses

Response samples

200
401

Content type

application/json

{"created_at": "2023-01-18T11:35:45.130Z",
"id": "023bfa42-3513-4cbf-b059-a9ddb4ea995d",
"name": "Acme Co.",
"owner_id": "e02c829c-0e2d-44b5-9057-07714ea613a3",
"login_path": "acme",
"updated_at": "2023-01-23T17:22:52.150Z",
"state": "active",
"retention_period_days": 90
}

Authentication

SSO Callback

Callback for authenticating via an organization's IdP

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

path Parameters

organizationLoginPath

required

string

The login path for the organization.

query Parameters

return_to

string

Return destination for the callback.

Responses

Response samples

400
401

Content type

application/problem+json

Example

Request Format is Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

Impersonation Settings

Get Impersonation Settings

Returns Impersonation Settings, which determines if user impersonation is allowed for an organization.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Responses

Response samples

200
401
404

Content type

application/json

{"enabled": true
}

Update Impersonation Settings

Updates Impersonation Settings.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Request Body schema: application/json

The request schema for adding a system account to a team.

enabled

boolean

Indicates if user impersonation is allowed for the organization.

Responses

Request samples

Payload

Content type

application/json

{"enabled": false
}

Response samples

200
400
401
403
404

Content type

application/json

{"enabled": false
}