settings.proto
path agntcy/identity/service/v1alpha1/settings.proto
package agntcy.identity.service.v1alpha1
Messages
ApiKey
An Identity API Key.
| Name | Type | Description |
|---|---|---|
api_key | optional string |
DuoIdpSettings
Duo IdP Settings
| Name | Type | Description |
|---|---|---|
hostname | optional string | |
integration_key | optional string | |
secret_key | optional string |
EntraIdpSettings
Entra ID (Azure AD) IdP Settings
| Name | Type | Description |
|---|---|---|
tenant_id | optional string | |
client_id | optional string | |
client_secret | optional string |
IssuerSettings
Issuer Settings
| Name | Type | Description |
|---|---|---|
issuer_id | optional string | A unique identifier for the Issuer. This is typically the Issuer's ID in the Identity. |
idp_type | optional IdpType | The type of the IdP. |
duo_idp_settings | optional DuoIdpSettings | Settings for the Duo Identity Provider. |
okta_idp_settings | optional OktaIdpSettings | Settings for the Okta Identity Provider. |
ory_idp_settings | optional OryIdpSettings | Settings for the Ory Identity Provider. |
keycloak_idp_settings | optional KeycloakIdpSettings | Settings for the Keycloak Identity Provider. |
ping_idp_settings | optional PingIdpSettings | Settings for the Ping Identity Provider. |
entra_idp_settings | optional EntraIdpSettings | Settings for the Entra ID Identity Provider. |
created_at | optional google.protobuf.Timestamp | CreatedAt records the timestamp of when the IssuerSettings was initially created |
updated_at | optional google.protobuf.Timestamp | UpdatedAt records the timestamp of the last update to the IssuerSettings |
KeycloakIdpSettings
Keycloak IdP Settings
| Name | Type | Description |
|---|---|---|
base_url | optional string | |
realm | optional string | |
client_id | optional string | |
client_secret | optional string |
OktaIdpSettings
Okta IdP Settings
| Name | Type | Description |
|---|---|---|
org_url | optional string | |
client_id | optional string | |
private_key | optional string |
OryIdpSettings
Ory IdP Settings
| Name | Type | Description |
|---|---|---|
project_slug | optional string | |
api_key | optional string |
PingIdpSettings
Ping IdP Settings
| Name | Type | Description |
|---|---|---|
environment_id | optional string | |
client_id | optional string | |
client_secret | optional string | |
region | optional string |
Settings
Identity Settings
| Name | Type | Description |
|---|---|---|
api_key | optional ApiKey | An API Key for the Identity Service. |
issuer_settings | optional IssuerSettings | Settings for the Issuer. |
Enums
IdpType
Type
| Name | Number | Description |
|---|---|---|
IDP_TYPE_UNSPECIFIED | 0 | Unspecified Envelope Type. |
IDP_TYPE_DUO | 1 | Idp Type Duo. |
IDP_TYPE_OKTA | 2 | Idp Type Okta. |
IDP_TYPE_ORY | 3 | Idp Type Ory. |
IDP_TYPE_SELF | 4 | Idp Type Self. |
IDP_TYPE_KEYCLOAK | 5 | Idp Type Keycloak. |
IDP_TYPE_PING | 6 | Idp Type Ping. |
IDP_TYPE_ENTRA_ID | 7 | Idp Type Entra ID |