Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Access

Users

Get users
client.ZeroTrust.Access.Users.List(ctx, params) (*V4PagePaginationArray[AccessUserListResponse], error)
GET/accounts/{account_id}/access/users
Get a user
client.ZeroTrust.Access.Users.Get(ctx, userID, query) (*AccessUserGetResponse, error)
GET/accounts/{account_id}/access/users/{user_id}
Create a user
client.ZeroTrust.Access.Users.New(ctx, params) (*AccessUserNewResponse, error)
POST/accounts/{account_id}/access/users
Update a user
client.ZeroTrust.Access.Users.Update(ctx, userID, params) (*AccessUserUpdateResponse, error)
PUT/accounts/{account_id}/access/users/{user_id}
Delete a user
client.ZeroTrust.Access.Users.Delete(ctx, userID, body) (*AccessUserDeleteResponse, error)
DELETE/accounts/{account_id}/access/users/{user_id}
ModelsExpand Collapse
type AccessUser struct{…}
ID stringoptional

The unique Cloudflare-generated Id of the SCIM resource.

Active booloptional

Determines the status of the SCIM User resource.

DisplayName stringoptional

The name of the SCIM User resource.

Emails []AccessUserEmailoptional
Primary booloptional

Indicates if the email address is the primary email belonging to the SCIM User resource.

Type stringoptional

Indicates the type of the email address.

Value stringoptional

The email address of the SCIM User resource.

formatemail
ExternalID stringoptional

The IdP-generated Id of the SCIM resource.

Meta AccessUserMetaoptional

The metadata of the SCIM resource.

Created Timeoptional

The timestamp of when the SCIM resource was created.

formatdate-time
LastModified Timeoptional

The timestamp of when the SCIM resource was last modified.

formatdate-time
Schemas []stringoptional

The list of URIs which indicate the attributes contained within a SCIM resource.

UsersActive Sessions

Get active sessions
client.ZeroTrust.Access.Users.ActiveSessions.List(ctx, userID, query) (*SinglePage[AccessUserActiveSessionListResponse], error)
GET/accounts/{account_id}/access/users/{user_id}/active_sessions
Get single active session
client.ZeroTrust.Access.Users.ActiveSessions.Get(ctx, userID, nonce, query) (*AccessUserActiveSessionGetResponse, error)
GET/accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce}

UsersLast Seen Identity

Get last seen identity
client.ZeroTrust.Access.Users.LastSeenIdentity.Get(ctx, userID, query) (*Identity, error)
GET/accounts/{account_id}/access/users/{user_id}/last_seen_identity
ModelsExpand Collapse
type Identity struct{…}
AccountID stringoptional
AuthStatus stringoptional
CommonName stringoptional
DeviceID stringoptional
DeviceSessions map[string, IdentityDeviceSession]optional
LastAuthenticated float64optional
DevicePosture map[string, IdentityDevicePosture]optional
ID stringoptional
Check IdentityDevicePostureCheckoptional
Exists booloptional
Path stringoptional
Data unknownoptional
Description stringoptional
Error stringoptional
RuleName stringoptional
Success booloptional
Timestamp stringoptional
Type stringoptional
Email stringoptional
Geo UserPolicyCheckGeooptional
Iat float64optional
IdP IdentityIdPoptional
ID stringoptional
Type stringoptional
IP stringoptional
IsGateway booloptional
IsWARP booloptional
MTLSAuth IdentityMTLSAuthoptional
AuthStatus stringoptional
CERTIssuerDn stringoptional
CERTIssuerSki stringoptional
CERTPresented booloptional
CERTSerial stringoptional
ServiceTokenID stringoptional
ServiceTokenStatus booloptional
UserUUID stringoptional
Version float64optional

UsersFailed Logins

Get failed logins
client.ZeroTrust.Access.Users.FailedLogins.List(ctx, userID, query) (*SinglePage[AccessUserFailedLoginListResponse], error)
GET/accounts/{account_id}/access/users/{user_id}/failed_logins