1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
|
from typing import TYPE_CHECKING, Any, NamedTuple, Optional
from botocore.exceptions import ParamValidationError
from moto.core.base_backend import BaseBackend
from moto.core.models import BackendDict
from moto.moto_api._internal import mock_random
from moto.utilities.paginator import paginate
from .exceptions import (
ConflictException,
ResourceNotFoundException,
ValidationException,
)
if TYPE_CHECKING:
from typing_extensions import Self
class Group(NamedTuple):
GroupId: str
DisplayName: str
ExternalIds: list[Optional[dict[str, str]]]
Description: str
IdentityStoreId: str
class Name(NamedTuple):
Formatted: Optional[str]
FamilyName: Optional[str]
GivenName: Optional[str]
MiddleName: Optional[str]
HonorificPrefix: Optional[str]
HonorificSuffix: Optional[str]
@classmethod
def from_dict(cls, name_dict: dict[str, str]) -> "Optional[Self]":
if not name_dict:
return None
return cls(
name_dict.get("Formatted"),
name_dict.get("FamilyName"),
name_dict.get("GivenName"),
name_dict.get("MiddleName"),
name_dict.get("HonorificPrefix"),
name_dict.get("HonorificSuffix"),
)
class User(NamedTuple):
UserId: str
IdentityStoreId: str
UserName: str
Name: Optional[Name]
DisplayName: str
NickName: str
ProfileUrl: str
Emails: list[dict[str, str]]
Addresses: list[dict[str, str]]
PhoneNumbers: list[dict[str, str]]
UserType: str
Title: str
PreferredLanguage: str
Locale: str
Timezone: str
class IdentityStoreData:
def __init__(self) -> None:
self.groups: dict[str, Group] = {}
self.users: dict[str, User] = {}
self.group_memberships: dict[str, Any] = {}
class IdentityStoreBackend(BaseBackend):
"""Implementation of IdentityStore APIs."""
PAGINATION_MODEL = {
"list_group_memberships": {
"input_token": "next_token",
"limit_key": "max_results",
"limit_default": 100,
"unique_attribute": "MembershipId",
},
"list_group_memberships_for_member": {
"input_token": "next_token",
"limit_key": "max_results",
"limit_default": 100,
"unique_attribute": "MembershipId",
},
"list_groups": {
"input_token": "next_token",
"limit_key": "max_results",
"limit_default": 100,
"unique_attribute": "GroupId",
},
"list_users": {
"input_token": "next_token",
"limit_key": "max_results",
"limit_default": 100,
"unique_attribute": "UserId",
},
}
def __init__(self, region_name: str, account_id: str) -> None:
super().__init__(region_name, account_id)
self.identity_stores: dict[str, IdentityStoreData] = {}
def create_group(
self, identity_store_id: str, display_name: str, description: str
) -> tuple[str, str]:
identity_store = self.__get_identity_store(identity_store_id)
matching = [
g for g in identity_store.groups.values() if g.DisplayName == display_name
]
if len(matching) > 0:
raise ConflictException(
message="Duplicate GroupDisplayName",
reason="UNIQUENESS_CONSTRAINT_VIOLATION",
)
group_id = str(mock_random.uuid4())
group = Group(
group_id,
display_name,
[],
description,
identity_store_id,
)
identity_store.groups[group_id] = group
return group_id, identity_store_id
def get_group_id(
self, identity_store_id: str, alternate_identifier: dict[str, Any]
) -> tuple[str, str]:
"""
The ExternalId alternate identifier is not yet implemented
"""
identity_store = self.__get_identity_store(identity_store_id)
if "UniqueAttribute" in alternate_identifier:
if (
"AttributeValue" in alternate_identifier["UniqueAttribute"]
and alternate_identifier["UniqueAttribute"]["AttributePath"].lower()
== "displayname"
):
for g in identity_store.groups.values():
if (
g.DisplayName
== alternate_identifier["UniqueAttribute"]["AttributeValue"]
):
return g.GroupId, identity_store_id
raise ResourceNotFoundException(
message="GROUP not found.", resource_type="GROUP"
)
def describe_group(self, identity_store_id: str, group_id: str) -> Group:
identity_store = self.__get_identity_store(identity_store_id)
if group_id in identity_store.groups:
g = identity_store.groups[group_id]
# External Ids are not implemented
external_ids: list[Any] = []
return Group(
g.GroupId,
g.DisplayName,
external_ids,
g.Description,
identity_store_id,
)
raise ResourceNotFoundException(
message="GROUP not found.", resource_type="GROUP"
)
def delete_group(self, identity_store_id: str, group_id: str) -> None:
identity_store = self.__get_identity_store(identity_store_id)
if group_id in identity_store.groups:
del identity_store.groups[group_id]
def create_user(
self,
identity_store_id: str,
user_name: str,
name: dict[str, str],
display_name: str,
nick_name: str,
profile_url: str,
emails: list[dict[str, Any]],
addresses: list[dict[str, Any]],
phone_numbers: list[dict[str, Any]],
user_type: str,
title: str,
preferred_language: str,
locale: str,
timezone: str,
) -> tuple[str, str]:
identity_store = self.__get_identity_store(identity_store_id)
user_id = str(mock_random.uuid4())
new_user = User(
user_id,
identity_store_id,
user_name,
Name.from_dict(name),
display_name,
nick_name,
profile_url,
emails,
addresses,
phone_numbers,
user_type,
title,
preferred_language,
locale,
timezone,
)
self.__validate_create_user(new_user, identity_store)
identity_store.users[user_id] = new_user
return user_id, identity_store_id
def get_user_id(
self, identity_store_id: str, alternate_identifier: dict[str, Any]
) -> tuple[str, str]:
"""
The ExternalId alternate identifier is not yet implemented
"""
identity_store = self.__get_identity_store(identity_store_id)
if "UniqueAttribute" in alternate_identifier:
value = alternate_identifier["UniqueAttribute"].get("AttributeValue")
if not value:
raise ValidationException(
message="attribute value cannot be empty or null for attribute path"
)
path = alternate_identifier["UniqueAttribute"].get("AttributePath")
if path.lower() not in ["username", "emails.value"]:
raise ValidationException(
message=f"The attribute {path} is not a unique attribute",
)
path = path.lower()
for user in identity_store.users.values():
if path == "username" and user.UserName == value:
return user.UserId, identity_store_id
if path == "emails.value":
for email in user.Emails:
if email.get("Value") == value:
return user.UserId, identity_store_id
raise ResourceNotFoundException(message="USER not found.", resource_type="USER")
def describe_user(self, identity_store_id: str, user_id: str) -> User:
identity_store = self.__get_identity_store(identity_store_id)
if user_id in identity_store.users:
return identity_store.users[user_id]
raise ResourceNotFoundException(message="USER not found.", resource_type="USER")
def delete_user(self, identity_store_id: str, user_id: str) -> None:
identity_store = self.__get_identity_store(identity_store_id)
if user_id in identity_store.users:
del identity_store.users[user_id]
def create_group_membership(
self, identity_store_id: str, group_id: str, member_id: dict[str, str]
) -> tuple[str, str]:
identity_store = self.__get_identity_store(identity_store_id)
user_id = member_id["UserId"]
if user_id not in identity_store.users:
raise ResourceNotFoundException(
message="Member does not exist", resource_type="USER"
)
if group_id not in identity_store.groups:
raise ResourceNotFoundException(
message="Group does not exist", resource_type="GROUP"
)
membership_id = str(mock_random.uuid4())
identity_store.group_memberships[membership_id] = {
"IdentityStoreId": identity_store_id,
"MembershipId": membership_id,
"GroupId": group_id,
"MemberId": {"UserId": user_id},
}
return membership_id, identity_store_id
@paginate(pagination_model=PAGINATION_MODEL) # type: ignore
def list_group_memberships( # type: ignore[misc]
self, identity_store_id: str, group_id: str
) -> list[Any]:
identity_store = self.__get_identity_store(identity_store_id)
return [
m
for m in identity_store.group_memberships.values()
if m["GroupId"] == group_id
]
@paginate(pagination_model=PAGINATION_MODEL) # type: ignore[misc]
def list_group_memberships_for_member( # type: ignore[misc]
self, identity_store_id: str, member_id: dict[str, str]
) -> list[Any]:
identity_store = self.__get_identity_store(identity_store_id)
user_id = member_id["UserId"]
return [
m
for m in identity_store.group_memberships.values()
if m["MemberId"]["UserId"] == user_id
]
@paginate(pagination_model=PAGINATION_MODEL)
def list_groups(
self, identity_store_id: str, filters: list[dict[str, str]]
) -> list[Group]:
identity_store = self.__get_identity_store(identity_store_id)
if filters:
if filters[0].get("AttributePath") == "DisplayName":
displayname = filters[0].get("AttributeValue")
return [
m
for m in identity_store.groups.values()
if m.DisplayName == displayname
]
return list(identity_store.groups.values())
@paginate(pagination_model=PAGINATION_MODEL)
def list_users(
self, identity_store_id: str, filters: list[dict[str, str]]
) -> list[dict[str, str]]:
identity_store = self.__get_identity_store(identity_store_id)
users = []
if filters:
if filters[0].get("AttributePath") == "UserName":
username = filters[0].get("AttributeValue")
for m in identity_store.users.values():
if m.UserName == username:
user = m._asdict()
if user.get("Name"):
user["Name"] = m.Name._asdict() # type: ignore
users.append(user)
return users
for m in identity_store.users.values():
user = m._asdict()
if user.get("Name"):
user["Name"] = m.Name._asdict() # type: ignore
users.append(user)
return users
def delete_group_membership(
self, identity_store_id: str, membership_id: str
) -> None:
identity_store = self.__get_identity_store(identity_store_id)
if membership_id in identity_store.group_memberships:
del identity_store.group_memberships[membership_id]
def __get_identity_store(self, store_id: str) -> IdentityStoreData:
if len(store_id) < 1:
raise ParamValidationError(
msg="Invalid length for parameter IdentityStoreId, value: 0, valid min length: 1"
)
if store_id not in self.identity_stores:
self.identity_stores[store_id] = IdentityStoreData()
return self.identity_stores[store_id]
def __validate_create_user(
self, new_user: User, identity_store: IdentityStoreData
) -> None:
if not new_user.UserName:
raise ValidationException(message="userName is a required attribute")
missing = []
if not new_user.DisplayName:
missing.append("displayname")
if not new_user.Name:
missing.append("name")
else:
if not new_user.Name.GivenName:
missing.append("givenname")
if not new_user.Name.FamilyName:
missing.append("familyname")
if len(missing) > 0:
message = ", ".join(
[f"{att}: The attribute {att} is required" for att in missing]
)
raise ValidationException(message=message)
matching = [
u for u in identity_store.users.values() if u.UserName == new_user.UserName
]
if len(matching) > 0:
raise ConflictException(
message="Duplicate UserName", reason="UNIQUENESS_CONSTRAINT_VIOLATION"
)
identitystore_backends = BackendDict(IdentityStoreBackend, "identitystore")
|