|
| 1 | +syntax = "proto3"; |
| 2 | + |
| 3 | +package xai_api; |
| 4 | + |
| 5 | +import "google/protobuf/empty.proto"; |
| 6 | +import "google/protobuf/timestamp.proto"; |
| 7 | + |
| 8 | +// An API service to check status of an API key. |
| 9 | +service Auth { |
| 10 | + // Returns some information about an API key. |
| 11 | + rpc get_api_key_info(google.protobuf.Empty) returns (ApiKey) {} |
| 12 | +} |
| 13 | + |
| 14 | +// API key information. |
| 15 | +message ApiKey { |
| 16 | + // A redacted API key. The full API key will not be displayed after it has |
| 17 | + // been created. |
| 18 | + string redacted_api_key = 1; |
| 19 | + |
| 20 | + // ID of the user who created this API key. |
| 21 | + string user_id = 3; |
| 22 | + |
| 23 | + // Human-readable name for the API key. |
| 24 | + string name = 4; |
| 25 | + |
| 26 | + // Unix timestamp when the API key was created. |
| 27 | + google.protobuf.Timestamp create_time = 5; |
| 28 | + |
| 29 | + // Unix timestamp when the API key was last modified. |
| 30 | + google.protobuf.Timestamp modify_time = 9; |
| 31 | + |
| 32 | + // ID of the last user who modified the API key |
| 33 | + string modified_by = 11; |
| 34 | + |
| 35 | + // ID of the team this API key belongs to. |
| 36 | + string team_id = 6; |
| 37 | + |
| 38 | + // Access Control Lists (ACLs) associated with this key. |
| 39 | + // These indicate the resources that the API key has access to. |
| 40 | + repeated string acls = 7; |
| 41 | + |
| 42 | + // The ID of the API key. This is different from the API key itself. |
| 43 | + string api_key_id = 8; |
| 44 | + |
| 45 | + // Whether the API key is currently blocked from making API requests. |
| 46 | + bool api_key_blocked = 10; |
| 47 | + |
| 48 | + // Whether the team is currently blocked from making API requests. |
| 49 | + bool team_blocked = 13; |
| 50 | + |
| 51 | + // Whether the API key is currently disabled. |
| 52 | + bool disabled = 12; |
| 53 | +} |
0 commit comments