Falcon ID

Operations for the Falcon ID service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go	v0.22.0
TypeScript	v0.6.0
Rust
Ruby	v1.4.0

---

Table of Contents

Operation	Description
DeleteThirdPartyPasskeyRegistry delete_third_party_passkey_registry	Deletes third party passkey registries
GetThirdPartyPasskeyRegistry get_third_party_passkey_registry	Fetches third party passkey registries
QueryThirdPartyPasskeyRegistry query_third_party_passkey_registry	Query third party passkey registries
UpdateThirdPartyPasskeyRegistry update_third_party_passkey_registry	Updates third party passkey registries

---

DeleteThirdPartyPasskeyRegistry

Deletes third party passkey registries

Method DELETE

Route /falcon-id/entities/third-party-passkeys/v1

Scope Falcon Id: WRITE

PEP 8 delete_third_party_passkey_registry

Parameters

ids query · string or list of strings

Third party passkey registry IDs to delete

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import FalconId

falcon = FalconId(client_id=CLIENT_ID,
                  client_secret=CLIENT_SECRET
                  )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.delete_third_party_passkey_registry(ids=id_list)
print(response)

Operation ID

from falconpy import FalconId

falcon = FalconId(client_id=CLIENT_ID,
                  client_secret=CLIENT_SECRET
                  )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.DeleteThirdPartyPasskeyRegistry(ids=id_list)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("DeleteThirdPartyPasskeyRegistry",
                          ids=id_list)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/falcon_id"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  response, err := client.FalconId.DeleteThirdPartyPasskeyRegistry(
    &falcon_id.DeleteThirdPartyPasskeyRegistryParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.falconId.deleteThirdPartyPasskeyRegistry(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::FalconId.new

response = api.delete_third_party_passkey_registry(['ID1', 'ID2', 'ID3'])

puts response

Responses

200 OK

[
  "string"
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    "string"
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    "string"
  ]
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    "string"
  ]
}

---

---

GetThirdPartyPasskeyRegistry

Fetches third party passkey registries

Method GET

Route /falcon-id/entities/third-party-passkeys/v1

Scope Falcon Id: READ

PEP 8 get_third_party_passkey_registry

Parameters

ids query · string or list of strings

Third party passkey registry IDs to retrieve

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import FalconId

falcon = FalconId(client_id=CLIENT_ID,
                  client_secret=CLIENT_SECRET
                  )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_third_party_passkey_registry(ids=id_list)
print(response)

Operation ID

from falconpy import FalconId

falcon = FalconId(client_id=CLIENT_ID,
                  client_secret=CLIENT_SECRET
                  )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.GetThirdPartyPasskeyRegistry(ids=id_list)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("GetThirdPartyPasskeyRegistry",
                          ids=id_list)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/falcon_id"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  response, err := client.FalconId.GetThirdPartyPasskeyRegistry(
    &falcon_id.GetThirdPartyPasskeyRegistryParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.falconId.getThirdPartyPasskeyRegistry(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::FalconId.new

response = api.get_third_party_passkey_registry(['ID1', 'ID2', 'ID3'])

puts response

Responses

200 OK

[
  {
    "aid": "string",
    "cid": "string",
    "credential_id": "string",
    "device_name": "string",
    "enabled": false,
    "id": "string",
    "last_auth_result": "string",
    "last_used_at": "string",
    "registered_at": "string",
    "relying_party": "string",
    "security_check_required": false,
    "user_id": "string",
    "username": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "aid": "string",
      "cid": "string",
      "credential_id": "string",
      "device_name": "string",
      "enabled": false,
      "id": "string",
      "last_auth_result": "string",
      "last_used_at": "string",
      "registered_at": "string",
      "relying_party": "string",
      "security_check_required": false,
      "user_id": "string",
      "username": "string"
    }
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "aid": "string",
      "cid": "string",
      "credential_id": "string",
      "device_name": "string",
      "enabled": false,
      "id": "string",
      "last_auth_result": "string",
      "last_used_at": "string",
      "registered_at": "string",
      "relying_party": "string",
      "security_check_required": false,
      "user_id": "string",
      "username": "string"
    }
  ]
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "aid": "string",
      "cid": "string",
      "credential_id": "string",
      "device_name": "string",
      "enabled": false,
      "id": "string",
      "last_auth_result": "string",
      "last_used_at": "string",
      "registered_at": "string",
      "relying_party": "string",
      "security_check_required": false,
      "user_id": "string",
      "username": "string"
    }
  ]
}

---

---

QueryThirdPartyPasskeyRegistry

Query third party passkey registries

Method GET

Route /falcon-id/queries/third-party-passkeys/v1

Scope Falcon Id: READ

PEP 8 query_third_party_passkey_registry

Parameters

filter query · string

FQL filter

offset query · integer

Paging offset

limit query · integer

Paging limit

sort query · string

Sorting field and direction

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import FalconId

falcon = FalconId(client_id=CLIENT_ID,
                  client_secret=CLIENT_SECRET
                  )

response = falcon.query_third_party_passkey_registry(filter="string",
                                                     offset=integer,
                                                     limit=integer,
                                                     sort="string")
print(response)

Operation ID

from falconpy import FalconId

falcon = FalconId(client_id=CLIENT_ID,
                  client_secret=CLIENT_SECRET
                  )

response = falcon.QueryThirdPartyPasskeyRegistry(filter="string",
                                                 offset=integer,
                                                 limit=integer,
                                                 sort="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("QueryThirdPartyPasskeyRegistry",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/falcon_id"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  filter := "string"
  offset := int64(0)
  limit := int64(0)
  sort := "string"

  response, err := client.FalconId.QueryThirdPartyPasskeyRegistry(
    &falcon_id.QueryThirdPartyPasskeyRegistryParams{
      Filter: &filter,
      Offset: &offset,
      Limit: &limit,
      Sort: &sort,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.falconId.queryThirdPartyPasskeyRegistry(
  "string",  // filter
  integer,  // offset
  integer,  // limit
  "string"  // sort
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::FalconId.new

response = api.query_third_party_passkey_registry(filter: 'string',
                                                  offset: integer,
                                                  limit: integer,
                                                  sort: 'string')

puts response

Responses

200 OK

[
  "string"
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    "string"
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    "string"
  ]
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    "string"
  ]
}

---

---

UpdateThirdPartyPasskeyRegistry

Updates third party passkey registries

Method PATCH

Route /falcon-id/entities/third-party-passkeys/v1

Scope Falcon Id: WRITE

PEP 8 update_third_party_passkey_registry

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

enabled body · boolean

The enabled value.

id body · string

The id value.

Code Examples

Python

PEP 8

from falconpy import FalconId

falcon = FalconId(client_id=CLIENT_ID,
                  client_secret=CLIENT_SECRET
                  )

response = falcon.update_third_party_passkey_registry(enabled=boolean,
                                                      id="string")
print(response)

Operation ID

from falconpy import FalconId

falcon = FalconId(client_id=CLIENT_ID,
                  client_secret=CLIENT_SECRET
                  )

response = falcon.UpdateThirdPartyPasskeyRegistry(enabled=boolean, id="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = [
    {
        "enabled": boolean,
        "id": "string"
    }
]

response = falcon.command("UpdateThirdPartyPasskeyRegistry", body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/falcon_id"
  "github.com/crowdstrike/gofalcon/falcon/models"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  enabled := boolean
  id := "string"

  response, err := client.FalconId.UpdateThirdPartyPasskeyRegistry(
    &falcon_id.UpdateThirdPartyPasskeyRegistryParams{
      Body: []*models.FalconidapiThirdPartyPasskeyRegistryPatchRequestV1{
        {
          Enabled: &enabled,
          ID: &id,
        },
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.falconId.updateThirdPartyPasskeyRegistry(
  [{
    enabled: boolean,
    id: "string"
}]  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::FalconId.new

body = [Falcon::FalconidapiThirdPartyPasskeyRegistryPatchRequestV1.new(
  enabled: boolean,
  id: 'string'
)]

response = api.update_third_party_passkey_registry(body)

puts response

Responses

200 OK

[
  {
    "aid": "string",
    "cid": "string",
    "credential_id": "string",
    "device_name": "string",
    "enabled": false,
    "id": "string",
    "last_auth_result": "string",
    "last_used_at": "string",
    "registered_at": "string",
    "relying_party": "string",
    "user_id": "string",
    "username": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "aid": "string",
      "cid": "string",
      "credential_id": "string",
      "device_name": "string",
      "enabled": false,
      "id": "string",
      "last_auth_result": "string",
      "last_used_at": "string",
      "registered_at": "string",
      "relying_party": "string",
      "user_id": "string",
      "username": "string"
    }
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "aid": "string",
      "cid": "string",
      "credential_id": "string",
      "device_name": "string",
      "enabled": false,
      "id": "string",
      "last_auth_result": "string",
      "last_used_at": "string",
      "registered_at": "string",
      "relying_party": "string",
      "user_id": "string",
      "username": "string"
    }
  ]
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "aid": "string",
      "cid": "string",
      "credential_id": "string",
      "device_name": "string",
      "enabled": false,
      "id": "string",
      "last_auth_result": "string",
      "last_used_at": "string",
      "registered_at": "string",
      "relying_party": "string",
      "user_id": "string",
      "username": "string"
    }
  ]
}