Skip to content

✨ Source auth0: add new streams Organizations, OrganizationMembers, OrganizationMemberRoles #27500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion airbyte-integrations/connectors/source-auth0/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ COPY source_auth0 ./source_auth0
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.2.0
LABEL io.airbyte.version=0.3.0
LABEL io.airbyte.name=airbyte/source-auth0
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
connector_image: airbyte/source-auth0:dev
tests:
acceptance_tests:
spec:
- spec_path: "source_auth0/spec.yaml"
tests:
- spec_path: "source_auth0/spec.yaml"
connection:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
tests:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
- config_path: "secrets/config.json"
tests:
- config_path: "secrets/config.json"
basic_read:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
fail_on_extra_columns: false
incremental:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
future_state_path: "integration_tests/abnormal_state.json"
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
future_state:
future_state_path: "integration_tests/abnormal_state.json"
full_refresh:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,36 @@
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite",
"primary_key": [["client_id"]]
},
{
"stream": {
"name": "organizations",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite",
"primary_key": [["id"]]
},
{
"stream": {
"name": "organization_members",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite",
"primary_key": [["id"]]
},
{
"stream": {
"name": "organization_member_roles",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite",
"primary_key": [["id"]]
}
]
}
2 changes: 1 addition & 1 deletion airbyte-integrations/connectors/source-auth0/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ data:
connectorSubtype: api
connectorType: source
definitionId: 6c504e48-14aa-4221-9a72-19cf5ff1ae78
dockerImageTag: 0.2.0
dockerImageTag: 0.3.0
dockerRepository: airbyte/source-auth0
githubIssueLabel: source-auth0
icon: auth0.svg
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,7 @@
}
},
"allowed_logout_urls": {
"type": ["null", "array"],
"items": {
"type": ["string", "null"]
}
"type": ["null", "array"]
},
"oidc_backchannel_logout": {
"type": ["object", "null"],
Expand All @@ -97,10 +94,7 @@
}
},
"grant_types": {
"type": ["null", "array"],
"items": {
"type": ["string", "null"]
}
"type": ["null", "array"]
},
"jwt_configuration": {
"type": ["object", "null"],
Expand All @@ -121,8 +115,8 @@
}
},
"signing_keys": {
"type": ["array", "null"],
"items": {
"type": ["null", "array"],
"string": {
"type": ["object", "null"],
"additionalProperties": true
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": ["object", "null"],
"additionalProperties": true,
"properties": {
"id": {
"type": ["string", "null"]
},
"org_id": {
"type": ["string", "null"]
},
"user_id": {
"type": ["string", "null"]
},
"name": {
"type": ["string", "null"]
},
"description": {
"type": ["string", "null"]
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": ["object", "null"],
"additionalProperties": true,
"properties":{
"id": {
"type": ["string", "null"]
},
"org_id": {
"type": ["string", "null"]
},
"user_id": {
"type": ["string", "null"]
},
"name": {
"type": ["string", "null"]
},
"email": {
"type": ["string", "null"]
},
"picture": {
"type": ["string", "null"]
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": ["object", "null"],
"additionalProperties": true,
"properties": {
"id": {
"type": ["string", "null"]
},
"name": {
"type": ["string", "null"]
},
"display_name": {
"type": ["string", "null"]
},
"branding": {
"type": ["object", "null"],
"additionalProperties": true
},
"metadata": {
"type": ["object", "null"],
"additionalProperties": true
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@
"type": ["string", "null"]
},
"multifactor": {
"type": ["object", "null"],
"additionalProperties": true
"type": ["null", "array"]
},
"last_ip": {
"type": ["string", "null"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@
from airbyte_cdk.sources.streams import IncrementalMixin, Stream
from airbyte_cdk.sources.streams.http import HttpStream
from source_auth0.utils import get_api_endpoint, initialize_authenticator
from airbyte_cdk.sources.streams.core import StreamData

from airbyte_cdk.models import SyncMode


def read_full_refresh(stream_instance: Stream):
slices = stream_instance.stream_slices(sync_mode=SyncMode.full_refresh)
for _slice in slices:
records = stream_instance.read_records(stream_slice=_slice, sync_mode=SyncMode.full_refresh)
for record in records:
yield record


# Basic full refresh stream
Expand Down Expand Up @@ -123,13 +134,69 @@ class Clients(Auth0Stream):
primary_key = "client_id"
resource_name = "clients"


class Users(IncrementalAuth0Stream):
min_id = "1900-01-01T00:00:00.000Z"
primary_key = "user_id"
resource_name = "users"
cursor_field = "updated_at"


class Organizations(Auth0Stream):
primary_key = "id"
resource_name = "organizations"


class OrganizationMembers(Auth0Stream):
primary_key = "id"
resource_name = "members"

def __init__(self, url_base: str, *args, **kwargs):
super().__init__(url_base=url_base, *args, **kwargs)
self.organizations = Organizations(url_base=url_base, *args, **kwargs)

def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]:
for org in read_full_refresh(self.organizations):
for member in super().read_records(stream_slice={"organization_id": org["id"]}, **kwargs):
yield member

def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str:
return f"organizations/{stream_slice['organization_id']}/members"

def parse_response(self, response: requests.Response, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping]:
record = response.json().get(self.resource_name)
for r in record:
r["org_id"] = stream_slice["organization_id"]
r["id"] = stream_slice["organization_id"] + "_" + r["user_id"]
yield r


class OrganizationMemberRoles(Auth0Stream):
primary_key = "id"
resource_name = "roles"

def __init__(self, url_base: str, *args, **kwargs):
super().__init__(url_base=url_base, *args, **kwargs)
self.organization_members = OrganizationMembers(url_base=url_base, *args, **kwargs)

def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str:
return f"organizations/{stream_slice['organization_id']}/members/{stream_slice['user_id']}/roles"

def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]:
for org_member in read_full_refresh(self.organization_members):
for role in super().read_records(
stream_slice={"organization_id": org_member["org_id"], "user_id": org_member["user_id"]}, **kwargs
):
yield role

def parse_response(self, response: requests.Response, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping]:
record = response.json().get(self.resource_name)
for r in record:
r["org_id"] = stream_slice["organization_id"]
r["user_id"] = stream_slice["user_id"]
yield r


# Source
class SourceAuth0(AbstractSource):
def check_connection(self, logger: logging.Logger, config: Mapping[str, Any]) -> Tuple[bool, any]:
Expand All @@ -152,4 +219,10 @@ def check_connection(self, logger: logging.Logger, config: Mapping[str, Any]) ->

def streams(self, config: Mapping[str, Any]) -> List[Stream]:
initialization_params = {"authenticator": initialize_authenticator(config), "url_base": config.get("base_url")}
return [Clients(**initialization_params), Users(**initialization_params)]
return [
Clients(**initialization_params),
Organizations(**initialization_params),
OrganizationMembers(**initialization_params),
OrganizationMemberRoles(**initialization_params),
Users(**initialization_params),
]
Original file line number Diff line number Diff line change
Expand Up @@ -240,10 +240,50 @@ def clients_instance():
},
"organization_usage": "deny",
"organization_require_behavior": "no_prompt",
"client_authentication_methods": {"private_key_jwt": {"credentials": ["object"]}}
"client_authentication_methods": {"private_key_jwt": {"credentials": ["object"]}},
}


@pytest.fixture()
def organization_instance():
"""
Clients instance object response
"""
return {
"id": "my_org_id",
"name": "My application",
"display_name": "My display_name",
"branding": "brand",
"metadata": "metadata_example",
}

@pytest.fixture()
def organization_member_instance():
"""
Clients instance object response
"""
return {
"id": "my_org_id_my_user_id",
"org_id": "my_org_id",
"user_id": "my_user_id",
"name": "my_name",
"email": "my_email",
"picture": "my_picture",
}

@pytest.fixture()
def organization_member_roles_instance():
"""
Clients instance object response
"""
return {
"id": "something",
"org_id": "my_org_id",
"user_id": "my_user_id",
"name": "my_name",
"description": "desc",
}

@pytest.fixture()
def latest_record_instance():
"""
Expand Down
Loading