Konnect Identity (3.0.0)

Download OpenAPI specification:Download
URL: https://konghq.com
The management API for Kong Konnect Identity resources.
Roles

Get Predefined Roles

Retrieves the predefined, or system managed, roles.
Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessTokenclientToken
Responses

Response samples

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."
}
}
}
}