Verwalten von Benutzern und Gruppen mit SCIM¶

POST scim/v2/Users¶

Benutzer mit userName und loginName erstellen, die demselben Wert zugeordnet sind

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:2.0:User"
        ],
    "userName": "test_user_1",
    "password": "test",
    "name": {
        "givenName": "test",
        "familyName": "user"
        },
    "emails": [{
        "value": "test.user@snowflake.com"
        }
    ],
    "displayName": "test user",
    "active": true
}

Copy

Benutzer mit userName und loginName erstellen, die unterschiedlichen Werten zugeordnet sind

Wenn Okta Ihr Identitätsanbieter ist, führen Sie diese Schritte aus.

{
    "active": true,
    "displayName": "test user",
    "emails": [
        {
            "value": "test.user@snowflake.com"
        }
    ],
    "name": {
        "familyName": "test_last_name",
        "givenName": "test_first_name"
    },
    "password": "test_password",
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "snowflakeUserName": "USER5"
    },
    "userName": "USER5"
}

Copy

PATCH scim/v2/Users/{ID}¶

Benutzer mit userName und loginName aktualisieren, die demselben Wert zugeordnet sind.

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [{
        "op": "replace",
        "value": {
            "active": false
        }
    }]
}

Copy

Benutzer mit userName und loginName aktualisieren, die verschiedenen Werten zugeordnet sind.

Wenn Okta Ihr Identitätsanbieter ist, führen Sie diese Schritte aus.

{
    "Operations": [
        {
            "op": "Replace",
            "path": "userName",
            "value": "test_updated_name"
        },
        {
            "op": "Replace",
            "path": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.snowflakeUserName",
            "value": "USER5"
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ]
}

Copy

PUT scim/v2/Users/{ID}¶

Aktualisieren Sie einen Benutzer, einschließlich der Einstellungen in den Feldern "defaultRole", "defaultSecondaryRoles" und "defaultWarehouse".

Um die Eigenschaften "defaultRole", "defaultSecondaryRoles" und "defaultWarehouse" zu spezifizieren, benötigt Snowflake unbedingt eines der extension-Schemas. Beachten Sie, dass der einzig mögliche Wert für defaultSecondaryRoles der Wert "ALL" ist.

Bemerkung

Obwohl Snowflake dies unterstützt, sollten Sie bei Verwendung der PUT-Operation vorsichtig sein, da sie teurer ist als eine PATCH-Operation. Verwenden Sie stattdessen die Operation PATCH.

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
        ],
    "userName": "test_user_1",
    "password": "test",
    "name": {
        "givenName": "test",
        "familyName": "user"
        },
    "emails": [{
        "primary": true,
        "value": "test.user@snowflake.com",
        "type": "work"
        }
    ],
    "displayName": "test user",
    "active": true,
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "defaultRole" : "test_role",
        "defaultSecondaryRoles" : "ALL",
        "defaultWarehouse" : "test_warehouse"
    }
}

Copy

POST scim/v2/Groups¶

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
    "displayName":"scim_test_group2"
}

Copy

PATCH scim/v2/Groups/{ID}¶

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [{
        "op": "replace",
        "value": {
            "displayName": "updated_name"
            }
        },
        {
            "op" : "remove",
            "path": "members[value eq \"user_id_1\"]"
        },
        {
          "op": "add",
          "value": [{
            "value": "user_id_2"
            }]
        }
    ]
}

Copy