StackHawk Current User
This endpoint provides details about the requesting user. This information helps determine what access an authorized user has on the StackHawk platform, and how they are authenticated.
The StackHawk user is seperated into two sections. provider specifies how the user authenticates. external specifies details of the user, and the access they have to the StackHawk Platform.
User
A StackHawk User as identified by the platform.
| Parameter | Default | Description |
|---|---|---|
| stackhawkId | "" | An internal identifier for this user. This is not the user uuid. |
| provider | {} | Information about the login provider assigned to this user. Read More |
| external | {} | Information about the user itself, and how they appear in the platform. Read More |
| createdTimestamp | 0 | Creation timestamp of this user. |
ProviderInfo
Information about a users access Provider to the StackHawk platform.
| Parameter | Default | Description |
|---|---|---|
| slug | "UNKNOWN" | User access provider. |
| clientId | "" | Provider client Id. |
| created | 0 | Milliseconds since epoch timestamp of when the user access was granted. |
UserExternal
Information about the User and how they can access the platform.
| Parameter | Default | Description |
|---|---|---|
| id | "" | The UUID identifier of this user. |
| "" | Users email address. | |
| firstName | "" | Users first name. |
| lastName | "" | Users last name. |
| fullName | "" | Users full name. |
| avatarUrl | "" | Users avatar url. |
| applicationIds | [] | An array of application ids this user has access to. |
| organizations | [] | Organizations a user is a part of. Read More |
| preferences | {} | User preferences. Read More |
| metadata | [] | Metadata associated to this external user. Primarily used for stuffing 3rd party verification data. |
UserPreferences
User settings and preferences for interaction within StackHawk.
| Parameter | Default | Description |
|---|---|---|
| dontReceiveWeeklyEmail | false | If the user will be opted out of weekly organization update emails. |
| defaultOrganizationId | "" | The UUID identifier of the organization a user currently logs into. |
| dontReceiveTrialingEmails | false | If true, the user will be opted out of stackhawk subscription-trialing notifications. |
User preferences can be adjusted from the account settings page in the StackHawk platform.
UserOrganization
Represents the relationship between a User and an Organization they belong to.
| Parameter | Default | Description |
|---|---|---|
| organization | {} | The StackHawk organization this user belongs to. |
| role | "UNKNOWN" | The organization role the user belongs to within this organization. |
| features | [] | Specific access features available to this organization. |
| metadata | [] | The user's organizational specific metadata. |
| Parameter | Description |
|---|---|
| UNKNOWN | null |
| OWNER | null |
| ADMIN | null |
| MEMBER | null |
Organization
A StackHawk Organization.
| Parameter | Default | Description |
|---|---|---|
| id | "" | The UUID identifier of this StackHawk Organization. |
| name | "" | The name of this Organization. |
| subscription | {} | The billing subscription of this Organization. |
| isLinkedToExternalBilling | false | If this organization is yet connected to external billing (Stripe). |
| plan | "" | The feature plan this organization belongs to. |
| features | [] | Specific overrides to the feature flags in the plan. |
| settings | {} | Organization settings. |
| createdTimestamp | 0 | Creation timestamp of this organization. |
A StackHawk platform user can belong to many organizations.