{"openapi":"3.1.0","info":{"title":"Member Service","version":"2.10.1"},"paths":{"/organisations/{organisation_name}/client_credentials/":{"post":{"tags":["ClientCredentials"],"summary":"Create Client Credential","operationId":"create_client_credential_organisations__organisation_name__client_credentials__post","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClientCredentialInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshClientCredential"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"get":{"tags":["ClientCredentials"],"summary":"Get Client Credentials","operationId":"get_client_credentials_organisations__organisation_name__client_credentials__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"revoked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Revoked"}},{"name":"expire_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expire At Gte"}},{"name":"expire_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expire At Lte"}},{"name":"user_account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Account Id"}},{"name":"organisation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organisation Id"}},{"name":"impersonate_user","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Impersonate User"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"expired","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Expired"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ClientCredential_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["ClientCredentials"],"summary":"Admin Add Client Credential To Org Or Domain","operationId":"admin_add_client_credential_to_org_or_domain_organisations__organisation_name__client_credentials__put","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAddClientCredentialToOrgDomain"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Admin Add Client Credential To Org Or Domain Organisations Organisation Name Client Credentials Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/client_credentials/{client_id}":{"get":{"tags":["ClientCredentials"],"summary":"Get Client Credential","operationId":"get_client_credential_organisations__organisation_name__client_credentials__client_id__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCredential"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["ClientCredentials"],"summary":"Update Client Credential","operationId":"update_client_credential_organisations__organisation_name__client_credentials__client_id__put","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientCredentialInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Client Credential Organisations Organisation Name Client Credentials Client Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"delete":{"tags":["ClientCredentials"],"summary":"Revoke Client Credential","operationId":"revoke_client_credential_organisations__organisation_name__client_credentials__client_id__delete","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/client_credentials/{client_id}/roles/":{"put":{"tags":["ClientCredentials"],"summary":"Update Client Credential Roles","operationId":"update_client_credential_roles_organisations__organisation_name__client_credentials__client_id__roles__put","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIdentityRolesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Client Credential Roles Organisations Organisation Name Client Credentials Client Id Roles Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/client_credentials/{client_id}/roles/add/":{"post":{"tags":["ClientCredentials"],"summary":"Add Organisation Client Credential Roles","operationId":"add_organisation_client_credential_roles_organisations__organisation_name__client_credentials__client_id__roles_add__post","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddIdentityRolesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Add Organisation Client Credential Roles Organisations Organisation Name Client Credentials Client Id Roles Add Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/client_credentials/{client_id}/roles/remove/":{"delete":{"tags":["ClientCredentials"],"summary":"Remove Organisation Client Credential Roles","operationId":"remove_organisation_client_credential_roles_organisations__organisation_name__client_credentials__client_id__roles_remove__delete","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddIdentityRolesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Remove Organisation Client Credential Roles Organisations Organisation Name Client Credentials Client Id Roles Remove Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/client_credentials/{client_id}/refresh":{"put":{"tags":["ClientCredentials"],"summary":"Refresh Client Credential Secret","operationId":"refresh_client_credential_secret_organisations__organisation_name__client_credentials__client_id__refresh_put","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshClientCredential"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/user_accounts/{user_account_id}/client_credentials/":{"get":{"tags":["ClientCredentials"],"summary":"Get User Client Credentials","operationId":"get_user_client_credentials_user_accounts__user_account_id__client_credentials__get","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Account Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"revoked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Revoked"}},{"name":"expire_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expire At Gte"}},{"name":"expire_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expire At Lte"}},{"name":"organisation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organisation Id"}},{"name":"impersonate_user","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Impersonate User"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"expired","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Expired"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ClientCredential_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"post":{"tags":["ClientCredentials"],"summary":"Create Impersonate User Client Credentials","operationId":"create_impersonate_user_client_credentials_user_accounts__user_account_id__client_credentials__post","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImpersonateClientCredentialInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshClientCredential"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/user_accounts/{user_account_id}/client_credentials/{client_id}":{"get":{"tags":["ClientCredentials"],"summary":"Get User Client Credential","operationId":"get_user_client_credential_user_accounts__user_account_id__client_credentials__client_id__get","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCredential"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["ClientCredentials"],"summary":"Update User Client Credential","operationId":"update_user_client_credential_user_accounts__user_account_id__client_credentials__client_id__put","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientCredentialInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update User Client Credential User Accounts User Account Id Client Credentials Client Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"delete":{"tags":["ClientCredentials"],"summary":"Revoke User Client Credential","operationId":"revoke_user_client_credential_user_accounts__user_account_id__client_credentials__client_id__delete","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/user_accounts/{user_account_id}/client_credentials/{client_id}/refresh":{"put":{"tags":["ClientCredentials"],"summary":"User Refresh User Client Credential Secret","operationId":"user_refresh_user_client_credential_secret_user_accounts__user_account_id__client_credentials__client_id__refresh_put","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}},{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshClientCredential"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/client_credentials/":{"get":{"tags":["ClientCredentials"],"summary":"List Global Client Credentials","operationId":"list_global_client_credentials_client_credentials__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"revoked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Revoked"}},{"name":"expire_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expire At Gte"}},{"name":"expire_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expire At Lte"}},{"name":"user_account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Account Id"}},{"name":"organisation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organisation Id"}},{"name":"impersonate_user","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Impersonate User"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"expired","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Expired"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ClientCredential_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/":{"get":{"tags":["Organisations"],"summary":"Get Organisations","operationId":"get_organisations_organisations__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"display_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"organisation_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organisation Name"}},{"name":"user__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Organisation_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"post":{"tags":["Organisations"],"summary":"Create Organisation","operationId":"create_organisation_organisations__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganisationInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Create Organisation Organisations Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_id}":{"get":{"tags":["Organisations"],"summary":"Get Organisation By Id","operationId":"get_organisation_by_id_organisations__organisation_id__get","parameters":[{"name":"organisation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationWithDefaultRoles"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["Organisations"],"summary":"Update Organisation","operationId":"update_organisation_organisations__organisation_id__put","parameters":[{"name":"organisation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Organisation Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrganisationInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Organisation Organisations Organisation Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/users/{user_id}":{"delete":{"tags":["Organisations"],"summary":"Remove User From Organisation","operationId":"remove_user_from_organisation_organisations__organisation_name__users__user_id__delete","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisation-input-checks/":{"post":{"tags":["Organisations"],"summary":"Check Organisation Name","operationId":"check_organisation_name_organisation_input_checks__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationName"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/domains/":{"get":{"tags":["Domains"],"summary":"Get Domains","operationId":"get_domains_domains__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"display_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"domain_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain Name"}},{"name":"user__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Domain_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"post":{"tags":["Domains"],"summary":"Create Domain","operationId":"create_domain_domains__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Create Domain Domains Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/domains/{domain_id}":{"get":{"tags":["Domains"],"summary":"Get Domain By Id","operationId":"get_domain_by_id_domains__domain_id__get","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Domain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainWithDefaultRoles"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["Domains"],"summary":"Update Domain","operationId":"update_domain_domains__domain_id__put","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Domain Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDomainInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Domain Domains Domain Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/domains/{domain_name}/organisations/":{"post":{"tags":["Domains"],"summary":"Add Domain Organisation","operationId":"add_domain_organisation_domains__domain_name__organisations__post","parameters":[{"name":"domain_name","in":"path","required":true,"schema":{"type":"string","title":"Domain Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddDomainOrganisationInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Add Domain Organisation Domains Domain Name Organisations Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"delete":{"tags":["Domains"],"summary":"Remove Domain Organisation","operationId":"remove_domain_organisation_domains__domain_name__organisations__delete","parameters":[{"name":"domain_name","in":"path","required":true,"schema":{"type":"string","title":"Domain Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDomainOrganisationInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Remove Domain Organisation Domains Domain Name Organisations Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/republish_events/":{"post":{"tags":["Events"],"summary":"Republish Events","operationId":"republish_events_republish_events__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepublishEventsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/domain-input-checks/":{"post":{"tags":["Domains"],"summary":"Check Domain Name","operationId":"check_domain_name_domain_input_checks__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationName"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/permissions/":{"get":{"tags":["Permissions"],"summary":"Get Permissions","operationId":"get_permissions_permissions__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},{"name":"effect","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effect"}},{"name":"service","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service"}},{"name":"resource","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Permission_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/permissions/{permission_id}":{"get":{"tags":["Permissions"],"summary":"Get Permission","operationId":"get_permission_permissions__permission_id__get","parameters":[{"name":"permission_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Permission Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/identity/{simba_id}/permissions/":{"get":{"tags":["Permissions"],"summary":"Get Identity Permissions By Simba Id","operationId":"get_identity_permissions_by_simba_id_identity__simba_id__permissions__get","parameters":[{"name":"simba_id","in":"path","required":true,"schema":{"type":"string","title":"Simba Id"}},{"name":"service","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service"}},{"name":"resource","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"org_names__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Org Names In"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IdentityPermissionItem"},"title":"Response Get Identity Permissions By Simba Id Identity Simba Id Permissions Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/roles/":{"get":{"tags":["Roles"],"summary":"Get Roles","operationId":"get_roles_roles__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"is_custom_role","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Custom Role"}},{"name":"is_global","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Global"}},{"name":"is_org_role","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Org Role"}},{"name":"is_domain_role","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Domain Role"}},{"name":"organisation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Organisation Id"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"permission__name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Name"}},{"name":"permission__description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Description"}},{"name":"permission__effect","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Effect"}},{"name":"permission__service","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Service"}},{"name":"permission__resource","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Resource"}},{"name":"permission__action","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Action"}},{"name":"permission__order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Permission Order By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_RoleWithFlags_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/roles/{role_id}":{"get":{"tags":["Roles"],"summary":"Get Role","operationId":"get_role_roles__role_id__get","parameters":[{"name":"role_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Role Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/custom_system_roles/":{"post":{"tags":["Roles"],"summary":"Create Custom System Role","operationId":"create_custom_system_role_custom_system_roles__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomSystemRoleInput"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Create Custom System Role Custom System Roles Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/custom_system_roles/{role_id}":{"put":{"tags":["Roles"],"summary":"Update Custom System Role","operationId":"update_custom_system_role_custom_system_roles__role_id__put","parameters":[{"name":"role_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Role Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomRoleInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Custom System Role Custom System Roles Role Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"delete":{"tags":["Roles"],"summary":"Delete Custom System Role","operationId":"delete_custom_system_role_custom_system_roles__role_id__delete","parameters":[{"name":"role_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Role Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/roles/":{"post":{"tags":["Roles"],"summary":"Create Org Scoped Role","operationId":"create_org_scoped_role_organisations__organisation_name__roles__post","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomOrgRoleInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Create Org Scoped Role Organisations Organisation Name Roles Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"get":{"tags":["Roles"],"summary":"Get Org Scoped Roles","operationId":"get_org_scoped_roles_organisations__organisation_name__roles__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"is_custom_role","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Custom Role"}},{"name":"is_global","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Global"}},{"name":"is_org_role","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Org Role"}},{"name":"is_domain_role","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Domain Role"}},{"name":"organisation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Organisation Id"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"permission__name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Name"}},{"name":"permission__description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Description"}},{"name":"permission__effect","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Effect"}},{"name":"permission__service","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Service"}},{"name":"permission__resource","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Resource"}},{"name":"permission__action","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission Action"}},{"name":"permission__order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Permission Order By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_RoleWithoutPermissions_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/roles/{role_id}":{"get":{"tags":["Roles"],"summary":"Get Org Scoped Role","operationId":"get_org_scoped_role_organisations__organisation_name__roles__role_id__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"role_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Role Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["Roles"],"summary":"Update Org Scoped Role","operationId":"update_org_scoped_role_organisations__organisation_name__roles__role_id__put","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"role_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Role Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomRoleInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Org Scoped Role Organisations Organisation Name Roles Role Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"delete":{"tags":["Roles"],"summary":"Delete Org Scoped Role","operationId":"delete_org_scoped_role_organisations__organisation_name__roles__role_id__delete","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"role_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Role Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/templates/":{"post":{"tags":["Templates"],"summary":"Create Template","operationId":"create_template_templates__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTemplateInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Create Template Templates Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"get":{"tags":["Templates"],"summary":"Get Templates","operationId":"get_templates_templates__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"parent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Id"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Template_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/templates/{template_id}":{"get":{"tags":["Templates"],"summary":"Get Template","operationId":"get_template_templates__template_id__get","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Template Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["Templates"],"summary":"Update Template","operationId":"update_template_templates__template_id__put","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Template Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTemplateInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Template Templates Template Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/user_accounts/":{"get":{"tags":["Users"],"summary":"Get User Accounts","operationId":"get_user_accounts_user_accounts__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"}},{"name":"last_login__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login Gte"}},{"name":"last_login__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login Lte"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"default_organisation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Organisation Id"}},{"name":"profile__first_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile First Name"}},{"name":"profile__last_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Last Name"}},{"name":"profile__user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile User Id"}},{"name":"profile__order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Profile Order By"}},{"name":"role__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Id"}},{"name":"role__name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Name"}},{"name":"organisations__display_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organisations Display Name"}},{"name":"organisations__order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Organisations Order By"}},{"name":"organisations__organisation_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organisations Organisation Name"}},{"name":"organisations__name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organisations Name"}},{"name":"organisations__is_domain","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Organisations Is Domain"}},{"name":"user__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_OrgScopedUserAccount_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/user_accounts/summary/":{"get":{"tags":["Users"],"summary":"Get User Accounts Summary","operationId":"get_user_accounts_summary_user_accounts_summary__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"}},{"name":"last_login__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login Gte"}},{"name":"last_login__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login Lte"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"profile__first_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile First Name"}},{"name":"profile__last_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Last Name"}},{"name":"profile__user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile User Id"}},{"name":"profile__order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Profile Order By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_UserAccountSummary_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/user_accounts/{user_account_id}":{"get":{"tags":["Users"],"summary":"Get User Account","operationId":"get_user_account_user_accounts__user_account_id__get","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["Users"],"summary":"Update Account","description":"## Update a user account.\n\nThe provided password must be between 12 and 128 characters long.","operationId":"update_account_user_accounts__user_account_id__put","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserAccountInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Account User Accounts User Account Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"delete":{"tags":["Users"],"summary":"Delete Account","operationId":"delete_account_user_accounts__user_account_id__delete","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Delete Account User Accounts User Account Id Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/user_accounts/whoami/":{"get":{"tags":["Users"],"summary":"Whoami","operationId":"whoami_user_accounts_whoami__get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccount"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/user_accounts/{user_account_id}/user_profiles/{profile_id}":{"get":{"tags":["Users"],"summary":"Get User Profile","operationId":"get_user_profile_user_accounts__user_account_id__user_profiles__profile_id__get","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}},{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Profile Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["Users"],"summary":"Update Profile","operationId":"update_profile_user_accounts__user_account_id__user_profiles__profile_id__put","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}},{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Profile Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserProfileInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Profile User Accounts User Account Id User Profiles Profile Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/bulk-users-import-requests/":{"get":{"tags":["Bulk Users Import Requests"],"summary":"Get Bulk Users Import Requests","operationId":"get_bulk_users_import_requests_bulk_users_import_requests__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"submitted_by_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submitted By Id"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_BulkUsersImportRequest_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"post":{"tags":["Bulk Users Import Requests"],"summary":"Create Bulk Users Import Request","description":"## Uploads a CSV file with organisation/domain, user(s) and roles information\nThe endpoint uploads a CSV file, parses it, and saves the data. It is processed asynchronously.\n\nArgs:\n- `bulk_import_file`: A csv file of a specific format to add users to orgs, assign roles, remove roles and set\ndefault organisation for the user(s)\n\n\nEach row specifies the organisation/domains to which the user(s) with the respective role(s) should be added to\nand/or the roles to remove from a user that already belongs to the organisation/domain.\n\nThe user can be a new or existing user.\n\nEach row in the CSV file should follow the following format:\n**org name, user email;first name;last name|another user;;, roles to add, roles to remove, is_default_org, system_type**\ni.e.:\norg-a,user-1@org.com;user-fn1;user-ln1|user-2@org.com;user-fn2;user-ln2,RoleToAdd1|RoleToAdd2…, RoleToRemove1|RoleToRemove2, True, build\n\nThe CSV follows the following rules:\n- A valid CSV file\n- The file should be less than 1Mb\n- If headers are present the following: org_name, users, add_roles, remove_roles, is_default_org, system_type\n- At least the first two columns are required.\n- Any columns after the first six are ignored.\n- Columns and the rules:\n - **Ist column**: Organisation/domain name. The organisation or domain to which the user should be added.\n - This is required\n - The organisation or domain should exist, the bulk import does not create organisations or domains\n - **2nd column**: list of users to add to the organisation or domain.\n - At least one user is required\n - There can be multiple users, each separated by a |\n - The structure of a user should be: user's email; user’s first name; user’s last name\n i.e donald_duck@scass.py;Donald;duck\n - The user email is required and should be a valid email.\n - The first name and last name are optional for existing users i.e.\n - with no first name and last name: donald_duck@scass.py;; or just donald_duck@scass.py\n - with just first name: donald_duck@scass.py;Donald; or donald_duck@scass.py;donald\n - with just the last name donald_duck@scass.py;;duck\n - An example of multiple users: i.e. donald_duck@scass.py;Donald;Duck|daisy_duck@scass.py;daisy;duck\n - A new user should have a first name and last name if the same user is provided multiple times in the bulk import user request, then the last non-null value of the first and last name is used\n - Similarly for existing users, the last non-null entry of the first name and/or last name is updated if provided\n - **3rd column**: roles to add to the users for the organisation/domain\n - This column is optional\n - A list of role names separated by |. i.e Admin|GlobalAdmin|...\n - The role should belong to the organisation or domain\n - All global roles are ignored\n - **4th column**: The third column: roles to remove to the users for the organisation/domain\n - This column is optional\n - A list of role names separated by |. i.e Admin|GlobalAdmin|...\n - The role should belong to the user for the organisation or domain\n - All global roles are ignored\n - **5th column**: sets the organisation/domain as the default organisation/domain for the users.\n - This is optional, the values can be true or false.\n - **6th column**: The system type - Specifies the system the users belong to. values: 'build' or 'ensure'","operationId":"create_bulk_users_import_request_bulk_users_import_requests__post","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_bulk_users_import_request_bulk_users_import_requests__post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Create Bulk Users Import Request Bulk Users Import Requests Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/bulk-users-import-requests/{bulk_users_import_request_id}":{"get":{"tags":["Bulk Users Import Requests"],"summary":"Get Bulk Users Import Request","operationId":"get_bulk_users_import_request_bulk_users_import_requests__bulk_users_import_request_id__get","parameters":[{"name":"bulk_users_import_request_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Bulk Users Import Request Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUsersImportRequest"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/users/{user_account_id}/roles/":{"put":{"tags":["Users"],"summary":"Update Organisation User Account Roles","operationId":"update_organisation_user_account_roles_organisations__organisation_name__users__user_account_id__roles__put","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIdentityRolesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Organisation User Account Roles Organisations Organisation Name Users User Account Id Roles Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/users/{user_account_id}/roles/add/":{"post":{"tags":["Users"],"summary":"Add Organisation User Account Roles","operationId":"add_organisation_user_account_roles_organisations__organisation_name__users__user_account_id__roles_add__post","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddIdentityRolesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Add Organisation User Account Roles Organisations Organisation Name Users User Account Id Roles Add Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/users/{user_account_id}/roles/remove/":{"delete":{"tags":["Users"],"summary":"Remove Organisation User Account Roles","operationId":"remove_organisation_user_account_roles_organisations__organisation_name__users__user_account_id__roles_remove__delete","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddIdentityRolesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Remove Organisation User Account Roles Organisations Organisation Name Users User Account Id Roles Remove Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/users/":{"get":{"tags":["Users"],"summary":"Get Organisation Users","operationId":"get_organisation_users_organisations__organisation_name__users__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"}},{"name":"last_login__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login Gte"}},{"name":"last_login__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login Lte"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"profile__first_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile First Name"}},{"name":"profile__last_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Last Name"}},{"name":"profile__user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile User Id"}},{"name":"profile__order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Profile Order By"}},{"name":"role__id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Id"}},{"name":"role__name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Name"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_OrgScopedUserAccount_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"post":{"tags":["Users"],"summary":"Admin Add User To Org Domain","description":"## Adds a user to an organisation or domain with the roles specified\nAn admin endpoint to add a new or existing user to an org/domain, bypassing the invite process. A user can be\nadded to sub organisations of a domain at the same time with the respective roles.\n\nArgs:\n- `organisation name`: Name of the organisation/domain\n\n\n For an organisation or domain for existing user\n```\n {\n \"to_email\": \"email_of_user@scaas.py\",\n \"role_ids\": [\"f4e41abf-09ef-43f7-94c0-33ba51238828\", \"a4e41abf-09ef-43f7-94c0-33ba51238827\"],\n \"role_names\": [\"_Admin\", \"_OtherRole\"],\n \"is_default_org\": True,\n }\n```\n For an organisation or domain for existing user\n```\n {\n \"to_email\": \"email_of_user@scaas.py\",\n \"role_ids\": [\"f4e41abf-09ef-43f7-94c0-33ba51238828\", \"a4e41abf-09ef-43f7-94c0-33ba51238827\"],\n \"role_names\": [\"_Admin\", \"_OtherRole\"],\n \"user_info\": {\n \"first_name\": \"user first name\",\n \"last_name\": \"user last name\"\n },\n \"is_default_org\": true\n }\n```\nFor a domain with sub organisations\n```\n {\n \"to_email\": \"email_of_user@scaas.py\",\n \"role_ids\": [\"f4e41abf-09ef-43f7-94c0-33ba51238828\", \"a4e41abf-09ef-43f7-94c0-33ba51238827\"],\n \"role_names\": [\"_Admin\", \"_OtherRole\"],\n \"sub_organisations\": [\n {\n \"organisation_name\": \"Name of the organisation that belongs to the domain\",\n \"role_ids\": [\"list of role ids to assign to the user for the organisation\"],\n \"role_names\": [\"list of role names to assign to the user for the organisation\"]\n },\n ]\n \"user_info\": {\n \"first_name\": \"user first name\",\n \"last_name\": \"user last name\"\n },\n \"is_default_org\": true\n }\n```\n\nReturns:\n - id -UUID of the user.","operationId":"admin_add_user_to_org_domain_organisations__organisation_name__users__post","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAddUserToOrgDomain"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Admin Add User To Org Domain Organisations Organisation Name Users Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/users/summary/":{"get":{"tags":["Users"],"summary":"Get Organisation Users Summary","operationId":"get_organisation_users_summary_organisations__organisation_name__users_summary__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"}},{"name":"last_login__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login Gte"}},{"name":"last_login__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login Lte"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"profile__first_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile First Name"}},{"name":"profile__last_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Last Name"}},{"name":"profile__user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile User Id"}},{"name":"profile__order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Profile Order By"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_UserAccountSummary_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/users/{user_account_id}":{"get":{"tags":["Users"],"summary":"Get Organisation User","operationId":"get_organisation_user_organisations__organisation_name__users__user_account_id__get","parameters":[{"name":"user_account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Account Id"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgScopedUserAccount"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/invites/{invite_id}/reject":{"put":{"tags":["Invites"],"summary":"Reject Organisation Invite","operationId":"reject_organisation_invite_invites__invite_id__reject_put","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invite Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/invites/":{"get":{"tags":["Invites"],"summary":"Get User Invites","operationId":"get_user_invites_invites__get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"inviter_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inviter Id"}},{"name":"invitee_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Invitee Email"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"system_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Type"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"expired","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Expired"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Invite_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/invites/{invite_id}":{"get":{"tags":["Invites"],"summary":"Get Invite Info","operationId":"get_invite_info_invites__invite_id__get","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invite Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteInfo"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organisations/{organisation_name}/invites/":{"post":{"tags":["Invites"],"summary":"Create Organisation Invite","description":"## Creates organisation invites\n This endpoint creates the invites for an organisation/domain. Multiple invites can be sent to multiple users at\n the same time. While inviting a user to an organisation/domain, the roles the user should be assigned can also be\n specified. If no roles are specified, then the _default role will be assigned.\n This endpoint can also be used to invite a user(s) to a domain and it's organisations that belong to the domain\n at the same time with its respective roles.\n\n\n Args:\n - `organisation name`: Name of the organisation/domain\n\n\n Example:\n Body Payload:\n - **invites**: List of invites to create\n - **to_email**: Email of the user to invite.\n - **role_ids**: Ids of roles to assign to user for an organisation/domain.\n - **role_names**: Names of roles to assign to user for an organisation/domain.\n - **sub_organisations**: List of organisations of the domain to automatically invite along with domain.\n - **organisation_name**: Name of organisation that already belongs to the domain.\n - **role_ids**: Ids of roles to assign to user for an organisation.\n - **role_names**: Names of roles to assign to user for an organisation.\n\n For an organisation or domain\n ```\n{\n \"invites\": [\n {\n \"to_email\": \"email_of_user@scaas.py\",\n \"role_ids\": [\"f4e41abf-09ef-43f7-94c0-33ba51238828\", \"a4e41abf-09ef-43f7-94c0-33ba51238827\"],\n \"role_names\": [\"_Admin\", \"_OtherRole\"],\n\n },\n {\n \"to_email\": \"email_of_user2@scaas.py\",\n },\n ]\n }\n ```\n For a domain with sub organisations\n ```\n {\n \"invites\": [\n {\n \"to_email\": \"email_of_user@scaas.py\",\n \"role_ids\": [\"f4e41abf-09ef-43f7-94c0-33ba51238828\", \"a4e41abf-09ef-43f7-94c0-33ba51238827\"],\n \"role_names\": [\"_Admin\", \"_OtherDomainRole\"],\n \"sub_organisations\": [\n {\n organisation_name: \"Name of the organisation that belongs to the domain\",\n role_ids = [\"b4e41abf-09ef-43f7-94c0-33ba51238827\"],\n role_names: [\"OrgRole1\", \"OrgRole2\"]\n }\n ]\n }\n ]\n }\n ```\n\n Returns:\n - List of ids (UUIDs) of the newly created invites.","operationId":"create_organisation_invite_organisations__organisation_name__invites__post","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBulkInviteInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response Create Organisation Invite Organisations Organisation Name Invites Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"get":{"tags":["Invites"],"summary":"Get Organisation Invites","operationId":"get_organisation_invites_organisations__organisation_name__invites__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"inviter_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inviter Id"}},{"name":"invitee_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Invitee Email"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"system_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Type"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}},{"name":"expired","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Expired"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Invite_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/invites/{invite_id}/resend":{"patch":{"tags":["Invites"],"summary":"Resend User Invite","operationId":"resend_user_invite_organisations__organisation_name__invites__invite_id__resend_patch","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invite Id"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Resend User Invite Organisations Organisation Name Invites Invite Id Resend Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/invites/{invite_id}":{"get":{"tags":["Invites"],"summary":"Get Organisation Invite","operationId":"get_organisation_invite_organisations__organisation_name__invites__invite_id__get","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invite Id"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invite"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"delete":{"tags":["Invites"],"summary":"Revoke Organisation Invite","operationId":"revoke_organisation_invite_organisations__organisation_name__invites__invite_id__delete","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invite Id"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/invites/{invite_id}/accept-existing":{"put":{"tags":["Invites"],"summary":"Accept Invite For Existing User","operationId":"accept_invite_for_existing_user_invites__invite_id__accept_existing_put","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invite Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Accept Invite For Existing User Invites Invite Id Accept Existing Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/invites/{invite_id}/accept-new":{"put":{"tags":["Invites"],"summary":"Accept New User Invite","description":"## Accept a new user invite.\n\nThe provided password must be between 12 and 128 characters long.","operationId":"accept_new_user_invite_invites__invite_id__accept_new_put","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invite Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInputBase"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Accept New User Invite Invites Invite Id Accept New Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/version":{"get":{"tags":["Probes"],"summary":"Get Version","operationId":"get_version_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Get Version Version Get"}}}}}}},"/healthz":{"get":{"tags":["Probes"],"summary":"Health","operationId":"health_healthz_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Health Healthz Get"}}}}}}},"/readiness":{"get":{"tags":["Probes"],"summary":"Readiness","operationId":"readiness_readiness_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingResponses"}}}}}}},"/pingz":{"get":{"tags":["Probes"],"summary":"Ping","operationId":"ping_pingz_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingResponses"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/configurations/":{"get":{"tags":["ServiceAdmin"],"summary":"Get Generic Configurations","operationId":"get_generic_configurations_configurations__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ServiceConfigurations"},{"type":"null"}],"title":"Response Get Generic Configurations Configurations Get"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["ServiceAdmin"],"summary":"Set Generic Configurations","operationId":"set_generic_configurations_configurations__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceConfigurations"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/domains/{organisation_name}/configurations/":{"put":{"tags":["ServiceAdmin"],"summary":"Set Domain Configurations","operationId":"set_domain_configurations_domains__organisation_name__configurations__put","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainConfigurationRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceConfigurations"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"get":{"tags":["ServiceAdmin"],"summary":"Get Domain Configuration","operationId":"get_domain_configuration_domains__organisation_name__configurations__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ServiceConfigurations"},{"type":"null"}],"title":"Response Get Domain Configuration Domains Organisation Name Configurations Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/device-apps/{device_app_name}":{"get":{"tags":["DeviceAppAdmin"],"summary":"Get Device App","operationId":"get_device_app_organisations__organisation_name__device_apps__device_app_name__get","parameters":[{"name":"device_app_name","in":"path","required":true,"schema":{"type":"string","title":"Device App Name"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceApp"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/device-apps/":{"get":{"tags":["DeviceAppAdmin"],"summary":"Get Device Apps","operationId":"get_device_apps_organisations__organisation_name__device_apps__get","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"organisation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Organisation Id"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DeviceApp_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"post":{"tags":["DeviceAppAdmin"],"summary":"Create Device App","operationId":"create_device_app_organisations__organisation_name__device_apps__post","parameters":[{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceAppInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Create Device App Organisations Organisation Name Device Apps Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/device-apps/{device_app_name}/roles/":{"put":{"tags":["DeviceAppAdmin"],"summary":"Update Device App Roles","operationId":"update_device_app_roles_organisations__organisation_name__device_apps__device_app_name__roles__put","parameters":[{"name":"device_app_name","in":"path","required":true,"schema":{"type":"string","title":"Device App Name"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleNamesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Device App Roles Organisations Organisation Name Device Apps Device App Name Roles Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"delete":{"tags":["DeviceAppAdmin"],"summary":"Remove Device App Roles","operationId":"remove_device_app_roles_organisations__organisation_name__device_apps__device_app_name__roles__delete","parameters":[{"name":"device_app_name","in":"path","required":true,"schema":{"type":"string","title":"Device App Name"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleNamesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Remove Device App Roles Organisations Organisation Name Device Apps Device App Name Roles Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"post":{"tags":["DeviceAppAdmin"],"summary":"Add Device App Roles","operationId":"add_device_app_roles_organisations__organisation_name__device_apps__device_app_name__roles__post","parameters":[{"name":"device_app_name","in":"path","required":true,"schema":{"type":"string","title":"Device App Name"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleNamesInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Add Device App Roles Organisations Organisation Name Device Apps Device App Name Roles Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/device-apps/{app_name}/registrations/":{"post":{"tags":["DeviceAppRegistration"],"summary":"Create Device App Registration","description":"## Creates a Device App Registration\n This endpoint creates app registration in the db. Sends a request to Provision the Registrant Did and Device Did asynchronously.\n Updates the DB with Registrant task id and Device task id with the relevant task Id.\n\n Args:\n - `app_name`: Name of the Device app\n - `organisation name`: Name of the organisation/domain\n\n Example:\n Body Payload:\n **device_info: Information that identifies the device\n **app_info: Information that identifies the app\n **registrant_pub_key: Registrant public_key is the blockchain address, used for signing VPs (using blockchain address)\n **device_pub_key: Device public_key is the blockchain address, used for signing VPs (using blockchain address)\n **registrant_public_key_multicodec: Registrant multicodec is the encoded full public key for signing DPOP proofs (using public key)\n **device_public_key_multicodec: Device multicodec is the encoded full public key for signing DPOP proofs (using public key)\n\n\n For an organisation or domain\n ```\n{\n \"device_info\": \"FCCCFFFF-62FC-4ECB-B2F5-92C9E79AC7F9\",\n \"app_info\": \"see-mobile-app1.0.0\",\n \"registrant_pub_key\": \"0xd4039eB67CBB36429Ad9DD30187B94f6A5122244\",\n \"device_pub_key\": \"0xd4039eB67CBB36429Ad9DD30187B94f6A5122255\",\n \"registrant_public_key_multicodec\": \"zYshimdW4hBJNu19cyjVdYpzzAagjQB1eFZPofv22uSruHjZ\",\n \"registrant_public_key_multicodec\": \"fZ3shimdW4hBJNu19cyjVdYpzzAagjQB1eFZPofv22uSruHjZ\",\n\n }","operationId":"create_device_app_registration_organisations__organisation_name__device_apps__app_name__registrations__post","parameters":[{"name":"app_name","in":"path","required":true,"schema":{"type":"string","title":"App Name"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceAppRegistration"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Create Device App Registration Organisations Organisation Name Device Apps App Name Registrations Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"get":{"tags":["DeviceAppRegistration"],"summary":"Get Device App Registrations","operationId":"get_device_app_registrations_organisations__organisation_name__device_apps__app_name__registrations__get","parameters":[{"name":"app_name","in":"path","required":true,"schema":{"type":"string","title":"App Name"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"device_info","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Device Info"}},{"name":"app_info","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Info"}},{"name":"registrant_pub_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrant Pub Key"}},{"name":"registrant_did_task_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrant Did Task Id"}},{"name":"registrant_did_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrant Did Id"}},{"name":"registrant_public_key_multicodec","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrant Public Key Multicodec"}},{"name":"device_pub_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Device Pub Key"}},{"name":"device_did_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Device Did Id"}},{"name":"device_public_key_multicodec","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Device Public Key Multicodec"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"vc_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Id"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"created_at","title":"Order By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DeviceAppRegistration_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/organisations/{organisation_name}/device-apps/{app_name}/registrations/{registration_id}":{"get":{"tags":["DeviceAppRegistration"],"summary":"Get Device App Registration","operationId":"get_device_app_registration_organisations__organisation_name__device_apps__app_name__registrations__registration_id__get","parameters":[{"name":"app_name","in":"path","required":true,"schema":{"type":"string","title":"App Name"}},{"name":"registration_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Registration Id"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAppRegistration"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]},"put":{"tags":["DeviceAppRegistration"],"summary":"Update Device App Registration","operationId":"update_device_app_registration_organisations__organisation_name__device_apps__app_name__registrations__registration_id__put","parameters":[{"name":"app_name","in":"path","required":true,"schema":{"type":"string","title":"App Name"}},{"name":"registration_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Registration Id"}},{"name":"organisation_name","in":"path","required":true,"schema":{"type":"string","title":"Organisation Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeviceAppRegistrationInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Update Device App Registration Organisations Organisation Name Device Apps App Name Registrations Registration Id Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]}]}},"/account/security/2fa":{"get":{"tags":["TwoFactor","TwoFactor"],"summary":"Get Status","description":"Return the 2FA enrolment state for the current user.\n\n``has_pending_enrolment`` and\n``has_recovery_codes_pending_acknowledgement`` are derived inside\nthe repository; the SPA never sees the underlying ciphertexts.","operationId":"get_status_account_security_2fa_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/2fa/setup":{"get":{"tags":["TwoFactor","TwoFactor"],"summary":"Get Setup","description":"Start a fresh enrolment ceremony.\n\nOverwrites any prior pending secret — the SPA convention is\nthat a user can only have one in-flight enrolment at a time, so\nre-issuing setup is the recovery path for \"I closed the tab\nbefore scanning the QR\".","operationId":"get_setup_account_security_2fa_setup_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpSetupResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/2fa/setup/verify":{"post":{"tags":["TwoFactor","TwoFactor"],"summary":"Post Setup Verify","description":"Verify the first TOTP code and emit the plaintext recovery\ncodes for one-shot display.\n\nThe user MUST then call ``/setup/acknowledge`` to engage 2FA.\nThe plaintext is re-fetchable via ``/recovery-codes/show`` only\ninside that verified-pending-ack window.","operationId":"post_setup_verify_account_security_2fa_setup_verify_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpCodeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpRecoveryCodesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/2fa/setup/acknowledge":{"post":{"tags":["TwoFactor","TwoFactor"],"summary":"Post Setup Acknowledge","description":"Confirm recovery codes have been recorded; engage 2FA.\n\nIdempotent at the service layer — a second call after a\nsuccessful first is a no-op (the atomic enable flip's WHERE\nclause rejects when ``totp_enabled_at`` is already non-NULL).","operationId":"post_setup_acknowledge_account_security_2fa_setup_acknowledge_post","parameters":[],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/2fa/recovery-codes/show":{"get":{"tags":["TwoFactor","TwoFactor"],"summary":"Get Recovery Codes Show","description":"Re-display fallback during the verified-pending-ack window.\n\n404 once the user has acknowledged — the plaintext blob is\nhard-cleared inside the atomic enable flip. The user must\n``regenerate`` to obtain a fresh set.","operationId":"get_recovery_codes_show_account_security_2fa_recovery_codes_show_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpRecoveryCodesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/2fa/disable":{"post":{"tags":["TwoFactor","TwoFactor"],"summary":"Post Disable","description":"TOTP-gated disable. Recovery-code-as-disable-gate is NOT\nsupported (stolen-laptop attacker with one recovery code must\nnot be able to dismantle the second factor).","operationId":"post_disable_account_security_2fa_disable_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpCodeRequest"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/2fa/recovery-codes/regenerate":{"post":{"tags":["TwoFactor","TwoFactor"],"summary":"Post Recovery Codes Regenerate","description":"TOTP-gated DELETE + reinsert in the same transaction.\n\nDoes NOT refill the re-display blob — re-display is only\navailable during the initial verified-pending-ack window. The\nreturned codes are the SOLE shipment; the user must record them\nat receive-time.","operationId":"post_recovery_codes_regenerate_account_security_2fa_recovery_codes_regenerate_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpCodeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpRecoveryCodesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/passkeys":{"get":{"tags":["Passkeys","Passkeys"],"summary":"List Passkeys","description":"List the current user's passkeys (metadata only).","operationId":"list_passkeys_account_security_passkeys_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PasskeyResponse"},"title":"Response List Passkeys Account Security Passkeys Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/passkeys/register/options":{"post":{"tags":["Passkeys","Passkeys"],"summary":"Post Register Options","description":"Start a registration ceremony.\n\nReturns the ``PublicKeyCredentialCreationOptions`` JSON produced\nby ``options_to_json``. Raw challenge bytes are b64url in the\npayload; re-serialising through a model would mangle them, so the\nservice's JSON string passes through verbatim.","operationId":"post_register_options_account_security_passkeys_register_options_post","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/passkeys/register/verify":{"post":{"tags":["Passkeys","Passkeys"],"summary":"Post Register Verify","description":"Verify the attestation + persist the credential.\n\nThe pop-before-verify step, the first-passkey\n``tokens_invalidated_at`` bump, the user-binding swap defence,\nand the registered / first-for-user audit events all live in the\nservice function.","operationId":"post_register_verify_account_security_passkeys_register_verify_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasskeyRegisterVerifyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasskeyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/passkeys/{credential_pk}/delete":{"post":{"tags":["Passkeys","Passkeys"],"summary":"Post Delete Passkey","description":"Delete a passkey. The repository's user-binding WHERE clause\nis the swap defence — a stolen credential UUID scoped to another\nuser deletes nothing and collapses to the same 404 as a\nnonexistent id. The deleted-event emit lives in the service\nfunction.","operationId":"post_delete_passkey_account_security_passkeys__credential_pk__delete_post","parameters":[{"name":"credential_pk","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Credential Pk"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/account/security/passkeys/{credential_pk}/rename":{"post":{"tags":["Passkeys","Passkeys"],"summary":"Post Rename Passkey","description":"Rename a passkey. Same user-binding clause as delete. The\nrenamed-event emit lives in the service function.","operationId":"post_rename_passkey_account_security_passkeys__credential_pk__rename_post","parameters":[{"name":"credential_pk","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Credential Pk"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasskeyRenameRequest"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AddDomainOrganisationInput":{"properties":{"organisation_name":{"type":"string","title":"Organisation Name"}},"type":"object","required":["organisation_name"],"title":"AddDomainOrganisationInput"},"AddIdentityRolesInput":{"properties":{"role_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Role Ids","default":[]},"role_names":{"items":{"type":"string"},"type":"array","title":"Role Names","default":[]}},"type":"object","title":"AddIdentityRolesInput"},"AdminAddClientCredentialToOrgDomain":{"properties":{"role_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Role Ids","default":[]},"role_names":{"items":{"type":"string"},"type":"array","title":"Role Names","default":[]},"client_id":{"type":"string","format":"uuid","title":"Client Id"},"sub_organisations":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateInviteSubOrgsInput"},"type":"array","minItems":0},{"type":"null"}],"title":"Sub Organisations","description":"List of sub organisations for the domain"}},"type":"object","required":["client_id"],"title":"AdminAddClientCredentialToOrgDomain"},"AdminAddUserToOrgDomain":{"properties":{"to_email":{"type":"string","format":"email","title":"To Email","description":"Email of the user"},"role_ids":{"items":{"type":"string","format":"uuid"},"type":"array","minItems":0,"title":"Role Ids","description":"List of role ids to assign to user for the organisation/domain","default":[]},"role_names":{"items":{"type":"string"},"type":"array","minItems":0,"title":"Role Names","description":"List of role names to assign to user for organisation or domain","default":[]},"sub_organisations":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateInviteSubOrgsInput"},"type":"array","minItems":0},{"type":"null"}],"title":"Sub Organisations","description":"List of sub organisations for the domain"},"user_info":{"anyOf":[{"$ref":"#/components/schemas/UpdateUserProfileInput"},{"type":"null"}],"description":"Information of the user"},"is_default_org":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default Org","description":"Flag to specify default organisation for the user"}},"type":"object","required":["to_email"],"title":"AdminAddUserToOrgDomain"},"Body_create_bulk_users_import_request_bulk_users_import_requests__post":{"properties":{"bulk_import_file":{"type":"string","contentMediaType":"application/octet-stream","title":"Bulk Import File"}},"type":"object","required":["bulk_import_file"],"title":"Body_create_bulk_users_import_request_bulk_users_import_requests__post"},"BulkUsersImportRequest":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"status":{"$ref":"#/components/schemas/BulkUsersImportTaskStatus"},"errors":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Errors"},"submitted_by":{"$ref":"#/components/schemas/UserMoniker"}},"type":"object","required":["status","submitted_by"],"title":"BulkUsersImportRequest"},"BulkUsersImportTaskStatus":{"type":"string","enum":["pending","processing","completed","errored"],"title":"BulkUsersImportTaskStatus"},"ClientCredential":{"properties":{"secret":{"type":"string","title":"Secret"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"revoked":{"type":"boolean","title":"Revoked"},"expire_at":{"type":"string","format":"date-time","title":"Expire At"},"last_used":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used"},"user_account_id":{"type":"string","format":"uuid","title":"User Account Id"},"organisation":{"anyOf":[{"$ref":"#/components/schemas/Organisation"},{"type":"null"}]},"impersonate_user":{"type":"boolean","title":"Impersonate User"},"simba_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Simba Id"},"organisations":{"items":{"$ref":"#/components/schemas/OrganisationWithRoles"},"type":"array","minItems":0,"title":"Organisations","description":"List of organisations","default":[]}},"type":"object","required":["secret","name","revoked","expire_at","user_account_id","impersonate_user"],"title":"ClientCredential"},"CreateBulkInviteInput":{"properties":{"invites":{"items":{"$ref":"#/components/schemas/CreateInviteInput"},"type":"array","minItems":1,"title":"Invites","description":"List of invite to create"}},"type":"object","required":["invites"],"title":"CreateBulkInviteInput"},"CreateClientCredentialInput":{"properties":{"name":{"type":"string","title":"Name"},"expire_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expire At"},"sub_organisations":{"items":{"type":"string"},"type":"array","minItems":0,"title":"Sub Organisations","description":"List of sub organisation names for the domain","default":[]}},"type":"object","required":["name"],"title":"CreateClientCredentialInput"},"CreateCustomOrgRoleInput":{"properties":{"name":{"type":"string","title":"Name"},"display_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"},"inherited_roles":{"items":{"type":"string"},"type":"array","title":"Inherited Roles","default":[]}},"type":"object","required":["name"],"title":"CreateCustomOrgRoleInput"},"CreateCustomSystemRoleInput":{"properties":{"is_org_role":{"type":"boolean","title":"Is Org Role"},"is_domain_role":{"type":"boolean","title":"Is Domain Role"},"name":{"type":"string","title":"Name"},"display_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"},"inherited_roles":{"items":{"type":"string"},"type":"array","title":"Inherited Roles","default":[]},"is_global":{"type":"boolean","title":"Is Global"}},"type":"object","required":["is_org_role","is_domain_role","name","is_global"],"title":"CreateCustomSystemRoleInput"},"CreateDeviceAppInput":{"properties":{"name":{"type":"string","maxLength":40,"minLength":3,"pattern":"^[a-z0-9]+[a-z0-9-]+$","title":"Name"},"role_names":{"items":{"type":"string"},"type":"array","title":"Role Names"}},"type":"object","required":["name","role_names"],"title":"CreateDeviceAppInput"},"CreateDeviceAppRegistration":{"properties":{"device_info":{"type":"string","title":"Device Info"},"app_info":{"type":"string","title":"App Info"},"registrant_pub_key":{"type":"string","title":"Registrant Pub Key"},"device_pub_key":{"type":"string","title":"Device Pub Key"},"registrant_public_key_multicodec":{"type":"string","title":"Registrant Public Key Multicodec"},"device_public_key_multicodec":{"type":"string","title":"Device Public Key Multicodec"},"impersonate_user":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Impersonate User","default":false}},"type":"object","required":["device_info","app_info","registrant_pub_key","device_pub_key","registrant_public_key_multicodec","device_public_key_multicodec"],"title":"CreateDeviceAppRegistration"},"CreateDomainInput":{"properties":{"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"default_role_names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Default Role Names"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]},"name":{"type":"string","maxLength":40,"minLength":3,"pattern":"^[a-z0-9]+[a-z0-9-]+$","title":"Name"},"reference_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Domain"}},"type":"object","required":["name"],"title":"CreateDomainInput"},"CreateImpersonateClientCredentialInput":{"properties":{"name":{"type":"string","title":"Name"},"expire_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expire At"}},"type":"object","required":["name"],"title":"CreateImpersonateClientCredentialInput"},"CreateInviteInput":{"properties":{"to_email":{"type":"string","format":"email","title":"To Email","description":"Email of the user"},"role_ids":{"items":{"type":"string","format":"uuid"},"type":"array","minItems":0,"title":"Role Ids","description":"List of role ids to assign to user for the organisation/domain","default":[]},"role_names":{"items":{"type":"string"},"type":"array","minItems":0,"title":"Role Names","description":"List of role names to assign to user for organisation or domain","default":[]},"sub_organisations":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateInviteSubOrgsInput"},"type":"array","minItems":0},{"type":"null"}],"title":"Sub Organisations","description":"List of sub organisations for the domain"}},"type":"object","required":["to_email"],"title":"CreateInviteInput"},"CreateInviteSubOrgsInput":{"properties":{"organisation_name":{"type":"string","title":"Organisation Name","description":"The name of the sub organisation"},"role_ids":{"items":{"type":"string","format":"uuid"},"type":"array","minItems":0,"title":"Role Ids","description":"List of org role ids to assign to user for organisation","default":[]},"role_names":{"items":{"type":"string"},"type":"array","minItems":0,"title":"Role Names","description":"List of org role names to assign to user for organisation","default":[]}},"type":"object","required":["organisation_name"],"title":"CreateInviteSubOrgsInput"},"CreateOrganisationInput":{"properties":{"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"default_role_names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Default Role Names"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]},"name":{"type":"string","maxLength":40,"minLength":3,"pattern":"^[a-z0-9]+[a-z0-9-]+$","title":"Name"}},"type":"object","required":["name"],"title":"CreateOrganisationInput"},"CreateTemplateInput":{"properties":{"name":{"type":"string","title":"Name"},"template":{"type":"string","title":"Template"},"parent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Id"}},"type":"object","required":["name","template"],"title":"CreateTemplateInput"},"DeviceApp":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"organisation":{"$ref":"#/components/schemas/Organisation"},"roles":{"items":{"$ref":"#/components/schemas/RoleWithoutPermissions"},"type":"array","title":"Roles"}},"type":"object","required":["name","organisation","roles"],"title":"DeviceApp"},"DeviceAppRegistration":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"device_info":{"type":"string","title":"Device Info"},"app_info":{"type":"string","title":"App Info"},"registrant_pub_key":{"type":"string","title":"Registrant Pub Key"},"device_pub_key":{"type":"string","title":"Device Pub Key"},"registrant_public_key_multicodec":{"type":"string","title":"Registrant Public Key Multicodec"},"device_public_key_multicodec":{"type":"string","title":"Device Public Key Multicodec"},"impersonate_user":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Impersonate User","default":false},"registrant_id":{"type":"string","format":"uuid","title":"Registrant Id"},"registrant_did_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrant Did Id"},"registrant_did":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Registrant Did"},"device_did_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Device Did Id"},"device_did":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Device Did"},"vc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Id"},"vc":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Vc"},"status":{"$ref":"#/components/schemas/DeviceAppRegistrationStatus"},"device_public_key_hex":{"type":"string","title":"Device Public Key Hex"},"registrant_public_key_hex":{"type":"string","title":"Registrant Public Key Hex"},"errors":{"additionalProperties":true,"type":"object","title":"Errors","default":{}},"device_app":{"$ref":"#/components/schemas/DeviceAppSlim"}},"type":"object","required":["device_info","app_info","registrant_pub_key","device_pub_key","registrant_public_key_multicodec","device_public_key_multicodec","registrant_id","status","device_public_key_hex","registrant_public_key_hex","device_app"],"title":"DeviceAppRegistration"},"DeviceAppRegistrationStatus":{"type":"string","enum":["in-progress","complete","failed","revoked"],"title":"DeviceAppRegistrationStatus"},"DeviceAppSlim":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"DeviceAppSlim"},"Domain":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"is_domain":{"type":"boolean","title":"Is Domain"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]},"organisations":{"items":{"$ref":"#/components/schemas/Organisation"},"type":"array","title":"Organisations"},"reference_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Domain"}},"type":"object","required":["name","display_name","is_domain","organisations"],"title":"Domain"},"DomainConfiguration":{"properties":{"member_service_did_id":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"title":"Member Service Did Id"},"trust_profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trust Profile"},"apps_claim_schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apps Claim Schema"}},"type":"object","title":"DomainConfiguration"},"DomainConfigurationRequest":{"properties":{"member_service_did_id":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"title":"Member Service Did Id"},"trust_profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trust Profile"},"apps_claim_schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apps Claim Schema"},"status":{"$ref":"#/components/schemas/DomainConfigurationStatus"}},"type":"object","required":["status"],"title":"DomainConfigurationRequest"},"DomainConfigurationStatus":{"type":"string","enum":["RUNNING","COMPLETED","PARTIAL","FAILED"],"title":"DomainConfigurationStatus"},"DomainWithDefaultRoles":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"is_domain":{"type":"boolean","title":"Is Domain"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]},"default_roles":{"anyOf":[{"items":{"$ref":"#/components/schemas/RoleWithoutPermissions"},"type":"array"},{"type":"null"}],"title":"Default Roles","default":[]},"organisations":{"items":{"$ref":"#/components/schemas/Organisation"},"type":"array","title":"Organisations"},"reference_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Domain"}},"type":"object","required":["name","display_name","is_domain","organisations"],"title":"DomainWithDefaultRoles"},"Effect":{"type":"string","enum":["allow"],"title":"Effect"},"FreshClientCredential":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"simba_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Simba Id"},"name":{"type":"string","title":"Name"},"secret":{"type":"string","title":"Secret"}},"type":"object","required":["id","name","secret"],"title":"FreshClientCredential","description":"Only time the plain secret is provided, at it's creation"},"GenericConfigurationRequest":{"properties":{"member_client_cred_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Member Client Cred Id"},"member_client_cred_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Client Cred Secret"},"member_client_cred_simba_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Client Cred Simba Id"},"status":{"$ref":"#/components/schemas/DomainConfigurationStatus"}},"type":"object","required":["status"],"title":"GenericConfigurationRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"IdentityPermissionItem":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"is_org_scoped":{"type":"boolean","title":"Is Org Scoped"},"org_domain_name":{"type":"string","title":"Org Domain Name"},"service":{"type":"string","title":"Service"},"resource":{"type":"string","title":"Resource"},"action":{"type":"string","title":"Action"}},"type":"object","required":["id","name","is_org_scoped","org_domain_name","service","resource","action"],"title":"IdentityPermissionItem"},"Invite":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"inviter":{"$ref":"#/components/schemas/Inviter"},"invitee_email":{"type":"string","format":"email","title":"Invitee Email"},"status":{"$ref":"#/components/schemas/InviteStatus"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"},"system_type":{"$ref":"#/components/schemas/SystemTypes"},"org_domain":{"$ref":"#/components/schemas/OrganisationMinimal"},"roles":{"items":{"$ref":"#/components/schemas/RoleMinimal"},"type":"array","title":"Roles"},"sub_invites":{"anyOf":[{"items":{"$ref":"#/components/schemas/SubInvite"},"type":"array"},{"type":"null"}],"title":"Sub Invites"}},"type":"object","required":["inviter","invitee_email","status","expires_at","system_type","org_domain","roles"],"title":"Invite"},"InviteInfo":{"properties":{"system_type":{"$ref":"#/components/schemas/SystemTypes"},"new_user":{"type":"boolean","title":"New User"},"org_domain":{"$ref":"#/components/schemas/OrganisationMinimal"}},"type":"object","required":["system_type","new_user","org_domain"],"title":"InviteInfo"},"InviteStatus":{"type":"string","enum":["PENDING","ACCEPTED","REVOKED","REJECTED"],"title":"InviteStatus"},"Inviter":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","format":"email","title":"Email"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"}},"type":"object","required":["id","email","first_name","last_name"],"title":"Inviter"},"OrgScopedUserAccount":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"email":{"type":"string","format":"email","title":"Email"},"email_verified":{"type":"boolean","title":"Email Verified"},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login"},"profile":{"anyOf":[{"$ref":"#/components/schemas/UserProfile"},{"type":"null"}]},"organisations":{"items":{"$ref":"#/components/schemas/OrganisationWithRoles"},"type":"array","title":"Organisations","default":[]},"simba_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Simba Id"}},"type":"object","required":["email","email_verified"],"title":"OrgScopedUserAccount","description":"A model representing a organisation user account.\n\nThe field `email` is unique."},"Organisation":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"is_domain":{"type":"boolean","title":"Is Domain"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]}},"type":"object","required":["name","display_name","is_domain"],"title":"Organisation","description":"A model representing an organisation.\n\nThe field `name` is unique."},"OrganisationMinimal":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"OrganisationMinimal"},"OrganisationName":{"properties":{"name":{"type":"string","maxLength":40,"minLength":3,"pattern":"^[a-z0-9]+[a-z0-9-]+$","title":"Name"}},"type":"object","required":["name"],"title":"OrganisationName"},"OrganisationWithDefaultRoles":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"is_domain":{"type":"boolean","title":"Is Domain"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]},"default_roles":{"anyOf":[{"items":{"$ref":"#/components/schemas/RoleWithoutPermissions"},"type":"array"},{"type":"null"}],"title":"Default Roles","default":[]}},"type":"object","required":["name","display_name","is_domain"],"title":"OrganisationWithDefaultRoles"},"OrganisationWithRoles":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"is_domain":{"type":"boolean","title":"Is Domain"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]},"roles":{"items":{"$ref":"#/components/schemas/RoleMinimal"},"type":"array","title":"Roles"}},"type":"object","required":["name","display_name","is_domain","roles"],"title":"OrganisationWithRoles"},"Page_BulkUsersImportRequest_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BulkUsersImportRequest"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[BulkUsersImportRequest]"},"Page_ClientCredential_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ClientCredential"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[ClientCredential]"},"Page_DeviceAppRegistration_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DeviceAppRegistration"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[DeviceAppRegistration]"},"Page_DeviceApp_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DeviceApp"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[DeviceApp]"},"Page_Domain_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Domain"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[Domain]"},"Page_Invite_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Invite"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[Invite]"},"Page_OrgScopedUserAccount_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OrgScopedUserAccount"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[OrgScopedUserAccount]"},"Page_Organisation_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Organisation"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[Organisation]"},"Page_Permission_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[Permission]"},"Page_RoleWithFlags_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RoleWithFlags"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[RoleWithFlags]"},"Page_RoleWithoutPermissions_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RoleWithoutPermissions"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[RoleWithoutPermissions]"},"Page_Template_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Template"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[Template]"},"Page_UserAccountSummary_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/UserAccountSummary"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[UserAccountSummary]"},"PasskeyRegisterVerifyRequest":{"properties":{"nickname":{"type":"string","maxLength":64,"minLength":1,"title":"Nickname"},"credential":{"additionalProperties":true,"type":"object","title":"Credential"}},"type":"object","required":["nickname","credential"],"title":"PasskeyRegisterVerifyRequest","description":"``POST /register/verify`` body — the attestation JSON from\n``@simplewebauthn/browser startRegistration`` plus the\nuser-chosen nickname."},"PasskeyRenameRequest":{"properties":{"nickname":{"type":"string","maxLength":64,"minLength":1,"title":"Nickname"}},"type":"object","required":["nickname"],"title":"PasskeyRenameRequest"},"PasskeyResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"nickname":{"type":"string","title":"Nickname"},"device_type":{"type":"string","title":"Device Type"},"backed_up":{"type":"boolean","title":"Backed Up"},"transports":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Transports"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"}},"type":"object","required":["id","nickname","device_type","backed_up"],"title":"PasskeyResponse","description":"SPA listing / registration-result shape.\n\nMetadata only — the credential public key + raw credential id\nbytes never cross the HTTP boundary (audit events follow the\nsame rule)."},"Permission":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"service":{"type":"string","title":"Service"},"resource":{"type":"string","title":"Resource"},"action":{"type":"string","title":"Action"},"is_org_scoped":{"type":"boolean","title":"Is Org Scoped"},"resource_attributes":{"additionalProperties":true,"type":"object","title":"Resource Attributes"},"urls":{"items":{"type":"string"},"type":"array","title":"Urls","default":[]},"effect":{"$ref":"#/components/schemas/Effect"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["name","description","service","resource","action","is_org_scoped","resource_attributes","effect"],"title":"Permission","description":"A model representing a permission."},"PingResponse":{"properties":{"component":{"type":"string","title":"Component"},"success":{"type":"boolean","title":"Success"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["component","success"],"title":"PingResponse"},"PingResponses":{"properties":{"service":{"type":"string","title":"Service"},"responses":{"items":{"$ref":"#/components/schemas/PingResponse"},"type":"array","title":"Responses"}},"type":"object","required":["service","responses"],"title":"PingResponses"},"RedactedGenericConfiguration":{"properties":{"member_client_cred_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Member Client Cred Id"},"member_client_cred_secret":{"anyOf":[{"type":"string"},{"type":"string","format":"password","writeOnly":true},{"type":"null"}],"title":"Member Client Cred Secret"},"member_client_cred_simba_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Client Cred Simba Id"}},"type":"object","title":"RedactedGenericConfiguration"},"RemoveDomainOrganisationInput":{"properties":{"organisation_name":{"type":"string","title":"Organisation Name"}},"type":"object","required":["organisation_name"],"title":"RemoveDomainOrganisationInput"},"RepublishEventChoices":{"type":"string","enum":["organisation-added","domain-added","identity-added","identity-added-to-org-domain"],"title":"RepublishEventChoices"},"RepublishEventsInput":{"properties":{"event_choices":{"items":{"$ref":"#/components/schemas/RepublishEventChoices"},"type":"array","minItems":1,"title":"Event Choices"}},"type":"object","required":["event_choices"],"title":"RepublishEventsInput"},"Role":{"properties":{"is_org_role":{"type":"boolean","title":"Is Org Role"},"is_domain_role":{"type":"boolean","title":"Is Domain Role"},"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"display_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"},"is_global":{"type":"boolean","title":"Is Global"},"is_custom_role":{"type":"boolean","title":"Is Custom Role"},"organisation":{"anyOf":[{"$ref":"#/components/schemas/Organisation"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"inherited_roles":{"items":{"type":"string"},"type":"array","title":"Inherited Roles"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","title":"Permissions"}},"type":"object","required":["is_org_role","is_domain_role","name","is_global","is_custom_role","permissions"],"title":"Role","description":"A model representing a role."},"RoleMinimal":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"RoleMinimal"},"RoleNamesInput":{"properties":{"role_names":{"items":{"type":"string"},"type":"array","title":"Role Names","default":[]}},"type":"object","title":"RoleNamesInput"},"RoleWithFlags":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"organisation":{"anyOf":[{"$ref":"#/components/schemas/Organisation"},{"type":"null"}]},"is_org_role":{"type":"boolean","title":"Is Org Role"},"is_domain_role":{"type":"boolean","title":"Is Domain Role"},"is_global":{"type":"boolean","title":"Is Global"},"is_custom_role":{"type":"boolean","title":"Is Custom Role"}},"type":"object","required":["name","is_org_role","is_domain_role","is_global","is_custom_role"],"title":"RoleWithFlags"},"RoleWithoutPermissions":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"organisation":{"anyOf":[{"$ref":"#/components/schemas/Organisation"},{"type":"null"}]}},"type":"object","required":["name"],"title":"RoleWithoutPermissions"},"ServiceConfigurations":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"config_status":{"anyOf":[{"$ref":"#/components/schemas/DomainConfigurationStatus"},{"type":"null"}]},"config":{"anyOf":[{"$ref":"#/components/schemas/DomainConfiguration"},{"$ref":"#/components/schemas/RedactedGenericConfiguration"},{"type":"null"}],"title":"Config"},"state":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"State"}},"type":"object","title":"ServiceConfigurations"},"SubInvite":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"invitee_email":{"type":"string","format":"email","title":"Invitee Email"},"status":{"$ref":"#/components/schemas/InviteStatus"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"},"org_domain":{"$ref":"#/components/schemas/OrganisationMinimal"},"roles":{"items":{"$ref":"#/components/schemas/RoleMinimal"},"type":"array","title":"Roles"},"system_type":{"$ref":"#/components/schemas/SystemTypes"}},"type":"object","required":["invitee_email","status","expires_at","org_domain","roles","system_type"],"title":"SubInvite"},"SystemTypes":{"type":"string","enum":["ensure","build","dpp","see"],"title":"SystemTypes"},"Template":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","title":"Name"},"template":{"type":"string","title":"Template"},"parent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Id"}},"type":"object","required":["name","template"],"title":"Template","description":"A model representing a template.\n\nThe field `name` is unique."},"TotpCodeRequest":{"properties":{"code":{"type":"string","maxLength":64,"minLength":1,"title":"Code"}},"type":"object","required":["code"],"title":"TotpCodeRequest","description":"Body shape for every code-gated endpoint."},"TotpRecoveryCodesResponse":{"properties":{"recovery_codes":{"items":{"type":"string"},"type":"array","title":"Recovery Codes"}},"type":"object","required":["recovery_codes"],"title":"TotpRecoveryCodesResponse","description":"Body for endpoints that return plaintext recovery codes\n(one-shot generation + re-display)."},"TotpSetupResponse":{"properties":{"secret":{"type":"string","title":"Secret"},"qr_svg":{"type":"string","title":"Qr Svg"},"provisioning_uri":{"type":"string","title":"Provisioning Uri"}},"type":"object","required":["secret","qr_svg","provisioning_uri"],"title":"TotpSetupResponse","description":"``GET /account/security/2fa/setup`` payload."},"TotpStatusResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"has_pending_enrolment":{"type":"boolean","title":"Has Pending Enrolment"},"has_recovery_codes_pending_acknowledgement":{"type":"boolean","title":"Has Recovery Codes Pending Acknowledgement"}},"type":"object","required":["enabled","has_pending_enrolment","has_recovery_codes_pending_acknowledgement"],"title":"TotpStatusResponse","description":"``GET /account/security/2fa`` payload.\n\n``enabled`` is true when ``totp_enabled_at IS NOT NULL``.\n``has_pending_enrolment`` lets the SPA show \"you have an\nin-flight enrolment\" without leaking the pending secret itself."},"UpdateClientCredentialInput":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"UpdateClientCredentialInput"},"UpdateCustomRoleInput":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"display_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"},"inherited_roles":{"items":{"type":"string"},"type":"array","title":"Inherited Roles","default":[]}},"type":"object","title":"UpdateCustomRoleInput"},"UpdateDeviceAppRegistrationInput":{"properties":{"status":{"$ref":"#/components/schemas/DeviceAppRegistrationStatus","default":"revoked"}},"type":"object","title":"UpdateDeviceAppRegistrationInput"},"UpdateDomainInput":{"properties":{"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"default_role_names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Default Role Names"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]}},"type":"object","title":"UpdateDomainInput"},"UpdateIdentityRolesInput":{"properties":{"role_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Role Ids","default":[]},"role_names":{"items":{"type":"string"},"type":"array","title":"Role Names","default":[]}},"type":"object","title":"UpdateIdentityRolesInput"},"UpdateOrganisationInput":{"properties":{"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"default_role_names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Default Role Names"},"system_type":{"anyOf":[{"$ref":"#/components/schemas/SystemTypes"},{"type":"null"}]}},"type":"object","title":"UpdateOrganisationInput"},"UpdateTemplateInput":{"properties":{"name":{"type":"string","title":"Name"},"template":{"type":"string","title":"Template"},"parent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Id"}},"type":"object","required":["name","template"],"title":"UpdateTemplateInput"},"UpdateUserAccountInput":{"properties":{"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password"},"default_organisation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Organisation Id"}},"type":"object","title":"UpdateUserAccountInput"},"UpdateUserProfileInput":{"properties":{"first_name":{"type":"string","title":"First Name","description":"First Name"},"last_name":{"type":"string","title":"Last Name","description":"Last Name"}},"type":"object","required":["first_name","last_name"],"title":"UpdateUserProfileInput"},"UserAccount":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"email":{"type":"string","format":"email","title":"Email"},"email_verified":{"type":"boolean","title":"Email Verified"},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login"},"profile":{"anyOf":[{"$ref":"#/components/schemas/UserProfile"},{"type":"null"}]},"simba_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Simba Id"},"default_organisation":{"anyOf":[{"$ref":"#/components/schemas/Organisation"},{"type":"null"}]},"terms_accepted_version":{"type":"string","title":"Terms Accepted Version","default":"pre-tracking"},"totp_enabled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Totp Enabled At"},"totp_last_used_slot":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Totp Last Used Slot"},"totp_recovery_codes_acknowledged_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Totp Recovery Codes Acknowledged At"},"tokens_invalidated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Tokens Invalidated At"},"organisations":{"items":{"$ref":"#/components/schemas/OrganisationWithRoles"},"type":"array","title":"Organisations","default":[]}},"type":"object","required":["email","email_verified"],"title":"UserAccount"},"UserAccountSummary":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"email":{"type":"string","format":"email","title":"Email"},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login"},"profile":{"anyOf":[{"$ref":"#/components/schemas/UserProfile"},{"type":"null"}]},"simba_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Simba Id"}},"type":"object","required":["email"],"title":"UserAccountSummary","description":"A model representing a organisation user account.\n\nThe field `email` is unique."},"UserInputBase":{"properties":{"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"password":{"type":"string","title":"Password"}},"type":"object","required":["first_name","last_name","password"],"title":"UserInputBase"},"UserMoniker":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["email"],"title":"UserMoniker"},"UserProfile":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"user_account_id":{"type":"string","format":"uuid","title":"User Account Id"}},"type":"object","required":["first_name","last_name","user_account_id"],"title":"UserProfile","description":"A model representing a user profile."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"OAuth2AuthorizationCodeBearer":{"type":"oauth2","flows":{"authorizationCode":{"scopes":{},"authorizationUrl":"https://blocks.simbachain.com/api/member-service-validator/oauth/authorize","tokenUrl":"https://blocks.simbachain.com/api/member-service-validator/oauth/token"}}}}}}