add GetAdminEvents

Nerzal · Jun 9, 2022 · b95ca62 · b95ca62
1 parent 9556250
commit b95ca62
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 0 deletions.
diff --git a/client.go b/client.go
@@ -3708,6 +3708,28 @@ func (client *gocloak) GetEvents(ctx context.Context, token string, realm string
 	return result, nil
 }
 
+// GetAdminEvents returns admin events
+func (client *gocloak) GetAdminEvents(ctx context.Context, token string, realm string, params GetAdminEventsParams) ([]*AdminEventRepresentation, error) {
+	const errMessage = "could not get admin events"
+
+	queryParams, err := GetQueryParams(params)
+	if err != nil {
+		return nil, errors.Wrap(err, errMessage)
+	}
+
+	var result []*AdminEventRepresentation
+	resp, err := client.getRequestWithBearerAuth(ctx, token).
+		SetResult(&result).
+		SetQueryParams(queryParams).
+		Get(client.getAdminRealmURL(realm, "admin-events"))
+
+	if err := checkForError(resp, err, errMessage); err != nil {
+		return nil, err
+	}
+
+	return result, nil
+}
+
 // GetClientScopesScopeMappingsRealmRolesAvailable returns realm-level roles that are available to attach to this client scope
 func (client *gocloak) GetClientScopesScopeMappingsRealmRolesAvailable(ctx context.Context, token, realm, clientScopeID string) ([]*Role, error) {
 	const errMessage = "could not get available realm-level roles with the client-scope"

diff --git a/gocloak.go b/gocloak.go
@@ -517,6 +517,8 @@ type GoCloak interface {
 
 	// GetEvents returns events
 	GetEvents(ctx context.Context, token string, realm string, params GetEventsParams) ([]*EventRepresentation, error)
+	// GetAdminEvents returns admin events
+	GetAdminEvents(ctx context.Context, token string, realm string, params GetAdminEventsParams) ([]*AdminEventRepresentation, error)
 
 	// -------------------
 	// RequiredActions API

diff --git a/models.go b/models.go
@@ -1275,6 +1275,40 @@ type EventRepresentation struct {
 	Details   map[string]string `json:"details,omitempty"`
 }
 
+// GetAdminEventsParams represents the optional parameters for getting events
+type GetAdminEventsParams struct {
+	AuthClient     *string  `json:"authClient,omitempty"`
+	AuthIpAddress  *string  `json:"authIpAddress,omitempty"`
+	AuthRealm      *string  `json:"authRealm,omitempty"`
+	AuthUser       *string  `json:"authUser,omitempty"`
+	DateFrom       *string  `json:"dateFrom,omitempty"`
+	DateTo         *string  `json:"dateTo,omitempty"`
+	First          *int32   `json:"first,omitempty"`
+	Max            *int32   `json:"max,omitempty"`
+	OperationTypes []string `json:"operationTypes,omitempty"`
+	ResourcePath   *string  `json:"resourcePath,omitempty"`
+	ResourceTypes  []string `json:"resourceTypes,omitempty"`
+}
+
+// AdminEventRepresentation is a representation of an Admin Event
+type AdminEventRepresentation struct {
+	Time           int64                                `json:"time,omitempty"`
+	OperationType  *string                              `json:"operationType,omitempty"`
+	RealmID        *string                              `json:"realmId,omitempty"`
+	ResourceType   *string                              `json:"resourceType,omitempty"`
+	ResourcePath   *string                              `json:"resourcePath,omitempty"`
+	AuthDetails    *AdminEventAuthDetailsRepresentation `json:"authDetails,omitempty"`
+	Representation *string                              `json:"representation,omitempty"`
+}
+
+// AdminEventAuthDetailsRepresentation is a representation of an Admin Event Details
+type AdminEventAuthDetailsRepresentation struct {
+	RealmID   *string `json:"realmId,omitempty"`
+	ClientID  *string `json:"clientId,omitempty"`
+	UserID    *string `json:"userId,omitempty"`
+	IPAddress *string `json:"ipAddress,omitempty"`
+}
+
 // CredentialRepresentation is a representations of the credentials
 // v7: https://www.keycloak.org/docs-api/7.0/rest-api/index.html#_credentialrepresentation
 // v8: https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_credentialrepresentation